@sanity/client 8.1.0 → 8.3.0

package/dist/index.node.d.ts

@@ -1224,6 +1224,508 @@ declare function _listen<R extends Record<string, Any> = Record<string, Any>>(th
  * @public
  */
 declare function _listen<R extends Record<string, Any> = Record<string, Any>, Opts extends ListenOptions | ResumableListenOptions = ListenOptions | ResumableListenOptions>(this: SanityClient | ObservableSanityClient, query: string, params?: ListenParams, options?: Opts): Observable<ListenEventFromOptions<R, Opts>>;
+/** @internal */
+declare const possibleRequestOptions: readonly ['headers', 'signal', 'tag', 'timeout', 'token'];
+/**
+ * Request options honored by the collaboration comments methods.
+ *
+ * @alpha
+ */
+type CollaborationCommentsRequestOptions = Pick<RequestOptions, (typeof possibleRequestOptions)[number]>;
+/**
+ * Options for collaboration comments write methods.
+ *
+ * @alpha
+ */
+type CollaborationCommentsWriteOptions = CollaborationCommentsRequestOptions & {
+  /** Transaction ID to associate the write with */
+  transactionId?: string;
+};
+/**
+ * Listener options for `collaboration.comments.listen`.
+ *
+ * `includeAllVersions` is left out: comments are stored as `sanity.comment`
+ * documents with no drafts or versions, so it would never make a difference.
+ *
+ * @alpha
+ */
+type CollaborationCommentsListenOptions = Omit<ListenOptions, 'includeAllVersions'> | Omit<ResumableListenOptions, 'includeAllVersions'>;
+/**
+ * Status of a comment thread. Replies always share the status of their parent comment.
+ *
+ * @alpha
+ */
+type CollaborationCommentStatus = 'open' | 'resolved';
+/**
+ * Emoji short names that can be used as comment reactions.
+ *
+ * @alpha
+ */
+type CollaborationCommentReactionShortName = ':-1:' | ':+1:' | ':eyes:' | ':heart:' | ':heavy_plus_sign:' | ':rocket:';
+/**
+ * A single Portable Text block, as used in comment messages and content snapshots.
+ *
+ * @alpha
+ */
+interface CollaborationCommentPortableTextBlock {
+  _type: string;
+  children: Array<{
+    _type: string;
+    [key: string]: Any;
+  }>;
+  [key: string]: Any;
+}
+/**
+ * Comment message, as an array of Portable Text blocks.
+ *
+ * @alpha
+ */
+type CollaborationCommentMessage = CollaborationCommentPortableTextBlock[];
+/**
+ * The text an inline comment was anchored to, resolved by the API when the
+ * comment was created.
+ *
+ * Holds one entry per Portable Text block the selection spans, keyed by the
+ * block it came from. `text` is the plain text of that block with the selected
+ * part wrapped in the marker characters `\uF000` (start) and `\uF001` (end).
+ *
+ * @alpha
+ */
+interface CollaborationCommentSelection {
+  type: 'text';
+  value: {
+    _key: string;
+    text: string;
+  }[];
+}
+/**
+ * A comment document, as stored by the Comments API.
+ *
+ * @alpha
+ */
+interface CollaborationCommentDocument extends SanityDocument {
+  _type: 'sanity.comment';
+  _system?: {
+    /** ID of the user that created the comment */
+    createdBy?: string;
+  };
+  /** ID shared by a top-level comment and all of its replies */
+  threadId?: string;
+  /** Set on replies, pointing to the comment being replied to */
+  parentCommentId?: string;
+  message: CollaborationCommentMessage;
+  reactions: {
+    _key: string;
+    shortName: CollaborationCommentReactionShortName;
+    userId: string;
+    addedAt: string;
+  }[];
+  /** Arbitrary metadata stored with the comment by the creating application */
+  context?: Record<string, unknown>;
+  target: {
+    /** Global document reference (`resourceType:resourceId:documentId`, using the published document ID) */
+    document: {
+      _ref: `${string}:${string}:${string}`;
+      _type: 'globalDocumentReference';
+      _weak: true;
+    };
+    documentType: string;
+    /** The exact document ID the comment was created against, e.g. a draft or version ID */
+    sourceDocumentId: string;
+    documentRevisionId?: string;
+    /**
+     * Set for field and inline comments. `field` is the `path` the comment was
+     * created with; `selection` is set for inline comments only.
+     */
+    path?: {
+      field: string;
+      selection?: CollaborationCommentSelection;
+    };
+  };
+  /**
+   * Copy of the commented content, as it looked when the comment was created.
+   * Set for inline comments only, and holds just the selected fragment of each
+   * Portable Text block the selection spans.
+   */
+  contentSnapshot?: CollaborationCommentPortableTextBlock[];
+  status: CollaborationCommentStatus;
+  /** Set when the message has been updated after creation */
+  lastEditedAt?: string;
+}
+/**
+ * Inline text selection within a Portable Text field.
+ * Each endpoint pairs the `_key` of a Portable Text block with a character
+ * offset into that block's plain text.
+ *
+ * @alpha
+ */
+interface CollaborationCommentRange {
+  start: {
+    _key: string;
+    offset: number;
+  };
+  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
+ */
+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.
+ *
+ * The created comment stores this in a different shape: `path` becomes
+ * `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
+ */
+type CollaborationCommentTarget = {
+  documentId: string;
+  documentType: string;
+  documentRevisionId?: string;
+} & ({
+  /** 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;
+});
+/**
+ * Comment to create with `collaboration.comments.create`.
+ *
+ * A top-level comment requires `target`; a reply requires `parentCommentId` (never both).
+ * Replies inherit `target`, `status`, and `threadId` from the parent comment.
+ *
+ * ### Examples
+ *
+ * #### Top-level comment
+ * ```ts
+ * // `message` is an array of Portable Text blocks
+ * await client.collaboration.comments.create({
+ *   message,
+ *   target: {documentId: 'doc-1', documentType: 'article'},
+ * })
+ * ```
+ *
+ * #### 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({
+ *   message,
+ *   parentCommentId: 'comment-1',
+ * })
+ * ```
+ *
+ * @alpha
+ */
+type CollaborationCommentCreate = {
+  /** Provide to control the ID of the created comment document */
+  _id?: string;
+  message: CollaborationCommentMessage;
+  context?: Record<string, unknown>;
+} & ({
+  target: CollaborationCommentTarget;
+  threadId?: string;
+  parentCommentId?: never;
+} | {
+  parentCommentId: string;
+  target?: never;
+  threadId?: never;
+});
+/**
+ * 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
+ */
+type CollaborationCommentUpdate = {
+  /** Replaces the current message */
+  message?: CollaborationCommentMessage;
+  /** Cascades to the comment's replies */
+  status?: CollaborationCommentStatus;
+} & ({
+  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;
+});
+/**
+ * Comments on the configured organization resource.
+ *
+ * Requires `collaboration.organizationId`, plus either `resource` or `projectId` and `dataset`.
+ *
+ * @alpha
+ */
+declare class ObservableCollaborationCommentsClient {
+  #private;
+  constructor(client: ObservableSanityClient, httpRequest: HttpRequest);
+  /**
+   * Create a comment or reply on the configured resource.
+   *
+   * A top-level comment requires `target`; a reply requires `parentCommentId` (never both).
+   * Replies inherit `target`, `status`, and `threadId` from the parent comment.
+   *
+   * @param body - Comment to create
+   * @param options - Optional request options
+   * @returns The created comment
+   */
+  create(body: CollaborationCommentCreate, options?: CollaborationCommentsWriteOptions): Observable<CollaborationCommentDocument>;
+  /**
+   * Update an existing comment.
+   *
+   * Updating `status` cascades to the comment's replies.
+   *
+   * @param id - Comment document ID
+   * @param body - Fields to update
+   * @param options - Optional request options
+   * @returns The updated comment
+   */
+  update(id: string, body: CollaborationCommentUpdate, options?: CollaborationCommentsWriteOptions): Observable<CollaborationCommentDocument>;
+  /**
+   * Delete a comment and its replies.
+   *
+   * @param id - Comment document ID
+   * @param options - Optional request options
+   * @returns Mutation result, where `documentIds` covers the comment and every deleted reply
+   */
+  delete(id: string, options?: CollaborationCommentsWriteOptions): Observable<MultipleMutationResult>;
+  /**
+   * Add the current user's reaction to a comment.
+   *
+   * @param id - Comment document ID
+   * @param shortName - Emoji short name, for example `:+1:`
+   * @param options - Optional request options
+   * @returns The comment, with the reaction applied
+   */
+  addReaction(id: string, shortName: CollaborationCommentReactionShortName, options?: CollaborationCommentsWriteOptions): Observable<CollaborationCommentDocument>;
+  /**
+   * Remove the current user's reaction from a comment.
+   *
+   * @param id - Comment document ID
+   * @param shortName - Emoji short name, for example `:+1:`
+   * @param options - Optional request options
+   * @returns The comment, with the reaction removed
+   */
+  removeReaction(id: string, shortName: CollaborationCommentReactionShortName, options?: CollaborationCommentsWriteOptions): Observable<CollaborationCommentDocument>;
+  /**
+   * Build the global document reference used by `target.document._ref`, for use in
+   * queries and listeners.
+   *
+   * The reference is built from the configured `resource` and the published ID of
+   * the given document ID, since comment references always use published IDs.
+   *
+   * @example
+   * ```ts
+   * client.collaboration.comments.listen(
+   *   '*[_type == "sanity.comment" && target.document._ref == $ref]',
+   *   {ref: client.collaboration.comments.getTargetDocumentRef('doc-1')},
+   * )
+   * ```
+   *
+   * @param documentId - Document ID, in published, draft or version form
+   * @returns Global document reference, of the form `resourceType:resourceId:documentId`
+   */
+  getTargetDocumentRef(documentId: string): CollaborationCommentDocument['target']['document']['_ref'];
+  /**
+   * Fetch comments on the configured resource.
+   *
+   * Takes the same `query` and `params` as `client.fetch`, and switches from a
+   * GET to a POST for queries too large for the request URL in the same way,
+   * but queries the comments endpoint, which accepts none of the query options
+   * `client.fetch` does (`perspective`, `useCdn`, `filterResponse`,
+   * `resultSourceMap`, stega).
+   *
+   * The query runs against the organization store, which is not scoped to
+   * comments, so filter on `_type == "sanity.comment"`.
+   *
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Optional request options
+   */
+  fetch<R = unknown>(query: string, params?: QueryParams, options?: CollaborationCommentsRequestOptions): Observable<R>;
+  /**
+   * Listen for changes to comments on the configured resource.
+   *
+   * Mirrors `client.listen(query, params)`, and emits mutation events.
+   *
+   * @param query - GROQ-filter to listen to changes for
+   * @param params - Optional query parameters
+   */
+  listen(query: string, params?: QueryParams): Observable<MutationEvent<CollaborationCommentDocument>>;
+  /**
+   * Listen for changes to comments on the configured resource.
+   *
+   * Mirrors `client.listen(query, params, options)`.
+   *
+   * @param query - GROQ-filter to listen to changes for
+   * @param params - Optional query parameters
+   * @param options - The same listener options `client.listen` takes, forwarded
+   *   to the organization store's listener
+   */
+  listen<Opts extends CollaborationCommentsListenOptions>(query: string, params: QueryParams | undefined, options: Opts): Observable<ListenEventFromOptions<CollaborationCommentDocument, Opts>>;
+}
+/**
+ * Comments on the configured organization resource.
+ *
+ * Requires `collaboration.organizationId`, plus either `resource` or `projectId` and `dataset`.
+ *
+ * @alpha
+ */
+declare class CollaborationCommentsClient {
+  #private;
+  constructor(client: SanityClient, httpRequest: HttpRequest);
+  /**
+   * Create a comment or reply on the configured resource.
+   *
+   * A top-level comment requires `target`; a reply requires `parentCommentId` (never both).
+   * Replies inherit `target`, `status`, and `threadId` from the parent comment.
+   *
+   * @param body - Comment to create
+   * @param options - Optional request options
+   * @returns The created comment
+   */
+  create(body: CollaborationCommentCreate, options?: CollaborationCommentsWriteOptions): Promise<CollaborationCommentDocument>;
+  /**
+   * Update an existing comment.
+   *
+   * Updating `status` cascades to the comment's replies.
+   *
+   * @param id - Comment document ID
+   * @param body - Fields to update
+   * @param options - Optional request options
+   * @returns The updated comment
+   */
+  update(id: string, body: CollaborationCommentUpdate, options?: CollaborationCommentsWriteOptions): Promise<CollaborationCommentDocument>;
+  /**
+   * Delete a comment and its replies.
+   *
+   * @param id - Comment document ID
+   * @param options - Optional request options
+   * @returns Mutation result, where `documentIds` covers the comment and every deleted reply
+   */
+  delete(id: string, options?: CollaborationCommentsWriteOptions): Promise<MultipleMutationResult>;
+  /**
+   * Add the current user's reaction to a comment.
+   *
+   * @param id - Comment document ID
+   * @param shortName - Emoji short name, for example `:+1:`
+   * @param options - Optional request options
+   * @returns The comment, with the reaction applied
+   */
+  addReaction(id: string, shortName: CollaborationCommentReactionShortName, options?: CollaborationCommentsWriteOptions): Promise<CollaborationCommentDocument>;
+  /**
+   * Remove the current user's reaction from a comment.
+   *
+   * @param id - Comment document ID
+   * @param shortName - Emoji short name, for example `:+1:`
+   * @param options - Optional request options
+   * @returns The comment, with the reaction removed
+   */
+  removeReaction(id: string, shortName: CollaborationCommentReactionShortName, options?: CollaborationCommentsWriteOptions): Promise<CollaborationCommentDocument>;
+  /**
+   * Build the global document reference used by `target.document._ref`, for use in
+   * queries and listeners.
+   *
+   * The reference is built from the configured `resource` and the published ID of
+   * the given document ID, since comment references always use published IDs.
+   *
+   * @example
+   * ```ts
+   * const comments = await client.collaboration.comments.fetch(
+   *   '*[_type == "sanity.comment" && target.document._ref == $ref]',
+   *   {ref: client.collaboration.comments.getTargetDocumentRef('doc-1')},
+   * )
+   * ```
+   *
+   * @param documentId - Document ID, in published, draft or version form
+   * @returns Global document reference, of the form `resourceType:resourceId:documentId`
+   */
+  getTargetDocumentRef(documentId: string): CollaborationCommentDocument['target']['document']['_ref'];
+  /**
+   * Fetch comments on the configured resource.
+   *
+   * Takes the same `query` and `params` as `client.fetch`, and switches from a
+   * GET to a POST for queries too large for the request URL in the same way,
+   * but queries the comments endpoint, which accepts none of the query options
+   * `client.fetch` does (`perspective`, `useCdn`, `filterResponse`,
+   * `resultSourceMap`, stega).
+   *
+   * The query runs against the organization store, which is not scoped to
+   * comments, so filter on `_type == "sanity.comment"`.
+   *
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Optional request options
+   */
+  fetch<R = unknown>(query: string, params?: QueryParams, options?: CollaborationCommentsRequestOptions): Promise<R>;
+  /**
+   * Listen for changes to comments on the configured resource.
+   *
+   * Mirrors `client.listen(query, params)`, and emits mutation events.
+   *
+   * @param query - GROQ-filter to listen to changes for
+   * @param params - Optional query parameters
+   */
+  listen(query: string, params?: QueryParams): Observable<MutationEvent<CollaborationCommentDocument>>;
+  /**
+   * Listen for changes to comments on the configured resource.
+   *
+   * Mirrors `client.listen(query, params, options)`.
+   *
+   * @param query - GROQ-filter to listen to changes for
+   * @param params - Optional query parameters
+   * @param options - The same listener options `client.listen` takes, forwarded
+   *   to the organization store's listener
+   */
+  listen<Opts extends CollaborationCommentsListenOptions>(query: string, params: QueryParams | undefined, options: Opts): Observable<ListenEventFromOptions<CollaborationCommentDocument, Opts>>;
+}
 /**
  * @public
  */
@@ -1719,6 +2221,17 @@ interface InvokeFunctionRequest {
   signal?: AbortSignal;
 }
 /** @public */
+interface InvokeFunctionOptions {
+  /**
+   * Wait for the function to finish and resolve with its return value.
+   *
+   * Defaults to `false`: the invocation is started, the request resolves as soon
+   * as it is accepted, and the value is always `undefined`. Only function types
+   * that support running inline can be invoked synchronously.
+   */
+  sync?: boolean;
+}
+/** @public */
 declare class ObservableFunctionsClient {
   #private;
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest);
@@ -1726,12 +2239,21 @@ declare class ObservableFunctionsClient {
    * Invoke a deployed function by its blueprint name.
    *
    * The name is resolved within the stack given by `stackId` on the request or
-   * the client config. Passes the function's return value once it finishes.
+   * the client config. Starts the invocation and emits `undefined` as soon as
+   * it is accepted; pass `{sync: true}` to wait for the function's return value
+   * instead.
    *
    * @param functionName - name of the function, as declared in the blueprint
    * @param request - payload and request options
+   * @param options - invocation options
    */
-  invoke<R = unknown>(functionName: string, request?: InvokeFunctionRequest): Observable<R | undefined>;
+  invoke(functionName: string, request?: InvokeFunctionRequest, options?: InvokeFunctionOptions & {
+    sync?: false;
+  }): Observable<undefined>;
+  invoke<R = unknown>(functionName: string, request: InvokeFunctionRequest | undefined, options: InvokeFunctionOptions & {
+    sync: true;
+  }): Observable<R>;
+  invoke<R = unknown>(functionName: string, request?: InvokeFunctionRequest, options?: InvokeFunctionOptions): Observable<R | undefined>;
 }
 /** @public */
 declare class FunctionsClient {
@@ -1742,20 +2264,30 @@ declare class FunctionsClient {
    *
    * The name is resolved within the stack given by `stackId` on the request or
    * the client config, which costs one extra request per call. Rejects if the
-   * stack has no function by that name, or if the name resolves to anything
-   * other than a `sanity.function.pubsub` function.
+   * stack has no function by that name, or if the name resolves to a function
+   * type that cannot be invoked the way it was asked for.
    *
    * The lookup is scoped to `projectId`, or to `organizationId` when one is set
    * for a stack deployed at organization scope.
    *
-   * The request stays open until the function finishes, and resolves with its
-   * return value, or `undefined` if it returns nothing. Long-running functions
-   * may need an explicit `timeout`.
+   * The invocation is started by default: the promise resolves with `undefined`
+   * as soon as the call is accepted, without waiting for the function to run.
+   * Pass `{sync: true}` to keep the request open until the function finishes
+   * and resolve with its return value — long-running functions may then need an
+   * explicit `timeout`. Only `sanity.function.pubsub` functions can be invoked
+   * synchronously.
    *
    * @param functionName - name of the function, as declared in the blueprint
    * @param request - payload and request options
+   * @param options - invocation options
    */
-  invoke<R = unknown>(functionName: string, request?: InvokeFunctionRequest): Promise<R | undefined>;
+  invoke(functionName: string, request?: InvokeFunctionRequest, options?: InvokeFunctionOptions & {
+    sync?: false;
+  }): Promise<undefined>;
+  invoke<R = unknown>(functionName: string, request: InvokeFunctionRequest | undefined, options: InvokeFunctionOptions & {
+    sync: true;
+  }): Promise<R>;
+  invoke<R = unknown>(functionName: string, request?: InvokeFunctionRequest, options?: InvokeFunctionOptions): Promise<R | undefined>;
 }
 /** @internal */
 declare class ObservableMediaLibraryVideoClient {
@@ -2351,6 +2883,10 @@ declare class ObservableSanityClient {
   agent: {
     action: ObservableAgentsActionClient;
   };
+  collaboration: {
+    /** @alpha */
+    comments: ObservableCollaborationCommentsClient;
+  };
   functions: ObservableFunctionsClient;
   releases: ObservableReleasesClient;
   /**
@@ -2981,6 +3517,10 @@ declare class SanityClient {
   agent: {
     action: AgentActionsClient;
   };
+  collaboration: {
+    /** @alpha */
+    comments: CollaborationCommentsClient;
+  };
   functions: FunctionsClient;
   releases: ReleasesClient;
   /**
@@ -4109,6 +4649,16 @@ interface ClientConfig {
    * ID of the organization owning the blueprints stack
    */
   organizationId?: string;
+  /**
+   * Organization-scoped configuration for collaboration APIs.
+   *
+   * Currently this is used by `collaboration.comments` methods.
+   *
+   * @alpha
+   */
+  collaboration?: {
+    organizationId?: string;
+  };
 }
 /** @public */
 interface InitializedClientConfig extends ClientConfig {
@@ -4590,8 +5140,13 @@ type ReleaseAction = CreateReleaseAction | EditReleaseAction | PublishReleaseAct
 type VariantDefinitionAction = CreateVariantDefinitionAction | EditVariantDefinitionAction | DeleteVariantDefinitionAction;
 /** @public */
 type VersionAction = CreateVersionAction | DiscardVersionAction | ReplaceVersionAction | UnpublishVersionAction;
+/**
+ * @public
+ * @beta
+ */
+type VariantAction = CreateVariantAction | EditVariantAction | DeleteVariantAction | PublishVariantAction | UnpublishVariantAction;
 /** @public */
-type Action = CreateAction | ReplaceDraftAction | EditAction | DeleteAction | DiscardAction | PublishAction | UnpublishAction | VersionAction | ReleaseAction | VariantDefinitionAction;
+type Action = CreateAction | ReplaceDraftAction | EditAction | DeleteAction | DiscardAction | PublishAction | UnpublishAction | VersionAction | VariantAction | ReleaseAction | VariantDefinitionAction;
 /** @public */
 type ImportReleaseAction = {
   actionType: 'sanity.action.release.import';
@@ -4730,6 +5285,175 @@ interface UnpublishVersionAction {
   versionId: string;
   publishedId: string;
 }
+/**
+ * Creates a variant of a document, either by supplying the full document
+ * content, or the base ID of a document to copy.
+ *
+ * @public
+ * @beta
+ */
+type CreateVariantAction = {
+  actionType: 'sanity.action.document.variant.create';
+  /**
+   * ID of the document group to create a variant in. Must be a published
+   * document ID, without a `drafts.` or `versions.` prefix.
+   */
+  publishedId: string;
+  /**
+   * Name of the variant definition this document belongs to, as in
+   * `_.variants.{variantName}`. Must be a bare name, not a full document ID.
+   */
+  variantId: string;
+  /**
+   * Source bundle: `'drafts'`, or a release id.
+   *
+   * Defaults to the published bundle.
+   */
+  bundleId?: 'drafts' | (string & {});
+} & ({
+  /**
+   * The full document content. Requires a `_type` property.
+   */
+  document: SanityDocumentStub;
+  baseId?: never;
+  ifBaseRevisionId?: never;
+} | {
+  /**
+   * ID of an existing document to copy the content from.
+   */
+  baseId: string;
+  /**
+   * When set, the action fails unless the current revision of the base
+   * document matches this value.
+   */
+  ifBaseRevisionId?: string;
+  document?: never;
+});
+/**
+ * Modifies a variant version of a document by applying a patch.
+ *
+ * If no such variant document exists it is first created, by copying the
+ * variant's published sibling, or the published document if the variant was
+ * never published.
+ *
+ * @public
+ * @beta
+ */
+interface EditVariantAction {
+  actionType: 'sanity.action.document.variant.edit';
+  /**
+   * ID of the document group the variant belongs to. Must be a published
+   * document ID, without a `drafts.` or `versions.` prefix.
+   */
+  publishedId: string;
+  /**
+   * Name of the variant definition this document belongs to, as in
+   * `_.variants.{variantName}`. Must be a bare name, not a full document ID.
+   */
+  variantId: string;
+  /**
+   * Source bundle: `'drafts'`, or a release id.
+   *
+   * Defaults to the published bundle.
+   */
+  bundleId?: 'drafts' | (string & {});
+  /**
+   * Patch operations to apply.
+   */
+  patch: PatchOperations;
+}
+/**
+ * Deletes a variant of a document.
+ *
+ * @public
+ * @beta
+ */
+interface DeleteVariantAction {
+  actionType: 'sanity.action.document.variant.delete';
+  /**
+   * ID of the document group the variant belongs to. Must be a published
+   * document ID, without a `drafts.` or `versions.` prefix.
+   */
+  publishedId: string;
+  /**
+   * Name of the variant definition this document belongs to, as in
+   * `_.variants.{variantName}`. Must be a bare name, not a full document ID.
+   */
+  variantId: string;
+  /**
+   * Source bundle: `'drafts'`, or a release id.
+   *
+   * Defaults to the published bundle.
+   */
+  bundleId?: 'drafts' | (string & {});
+  /**
+   * Delete document history.
+   */
+  purge?: boolean;
+}
+/**
+ * Publishes a variant version of a document, replacing the published variant
+ * and removing the source variant document.
+ *
+ * @public
+ * @beta
+ */
+interface PublishVariantAction {
+  actionType: 'sanity.action.document.variant.publish';
+  /**
+   * ID of the document group the variant belongs to. Must be a published
+   * document ID, without a `drafts.` or `versions.` prefix.
+   */
+  publishedId: string;
+  /**
+   * Name of the variant definition this document belongs to, as in
+   * `_.variants.{variantName}`. Must be a bare name, not a full document ID.
+   */
+  variantId: string;
+  /**
+   * Bundle to publish from: `'drafts'`, or a release id.
+   */
+  bundleId: 'drafts' | (string & {});
+  /**
+   * When set, publishing fails unless the current revision of the source
+   * variant document matches this value.
+   */
+  ifVersionRevisionId?: string;
+  /**
+   * When set, publishing fails unless the current revision of the published
+   * variant document matches this value.
+   */
+  ifPublishedVariantRevisionId?: string;
+}
+/**
+ * Unpublishes a variant version of a document.
+ *
+ * By default the published variant is removed and preserved as a draft
+ * variant. When a release id is given as the `bundleId`, the deletion is
+ * instead staged in that release, and takes effect when it is published.
+ *
+ * @public
+ * @beta
+ */
+interface UnpublishVariantAction {
+  actionType: 'sanity.action.document.variant.unpublish';
+  /**
+   * ID of the document group the variant belongs to. Must be a published
+   * document ID, without a `drafts.` or `versions.` prefix.
+   */
+  publishedId: string;
+  /**
+   * Name of the variant definition this document belongs to, as in
+   * `_.variants.{variantName}`. Must be a bare name, not a full document ID.
+   */
+  variantId: string;
+  /**
+   * The content release in which to stage the unpublish.
+   *
+   * By default, the currently published document is unpublished immediately.
+   */
+  bundleId?: string;
+}
 /**
  * Creates a new `system.variant` definition document.
  *
@@ -5998,5 +6722,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, ConnectionFailedError, type ConstantAgentActionParam, ContentSourceMap, ContentSourceMapDocument, ContentSourceMapDocumentBase, ContentSourceMapDocumentValueSource, ContentSourceMapDocuments, ContentSourceMapLiteralSource, ContentSourceMapMapping, ContentSourceMapMappings, type ContentSourceMapParsedPath, type ContentSourceMapParsedPathKeyedSegment, ContentSourceMapPaths, ContentSourceMapRemoteDocument, ContentSourceMapSource, ContentSourceMapUnknownSource, ContentSourceMapValueMapping, CorsOriginError, CreateAction, CreateReleaseAction, CreateVariantDefinitionAction, CreateVersionAction, CurrentSanityUser, DatasetAclMode, DatasetCreateOptions, DatasetEditOptions, DatasetResponse, type DatasetsClient, DatasetsResponse, DeleteAction, DeleteReleaseAction, DeleteVariantDefinitionAction, DiscardAction, DiscardVersionAction, DisconnectError, DisconnectEvent, type DocumentAgentActionParam, EXPERIMENTAL_API_WARNING, EditAction, EditReleaseAction, 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 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 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, 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, SanityQueries, SanityReference, 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, UnpublishVersionAction, UnscheduleReleaseAction, UploadBody, UploadClientConfig, UploadEvent, UploadProgressEvent, UploadResponseEvent, type UsersClient, 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 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, 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, SanityQueries, SanityReference, 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.node.d.ts.map