@sanity/client 8.1.0 → 8.3.0

package/dist/{types-BODIEY7F.d.ts → types-0x2hPfhJ.d.ts}

@@ -1140,6 +1140,508 @@ declare function _listen<R extends Record<string, Any$1> = Record<string, Any$1>
  * @public
  */
 declare function _listen<R extends Record<string, Any$1> = Record<string, Any$1>, Opts extends ListenOptions | ResumableListenOptions = ListenOptions | ResumableListenOptions>(this: SanityClient$1 | ObservableSanityClient$1, 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$1, (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$1;
+  }>;
+  [key: string]: Any$1;
+}
+/**
+ * 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$1 {
+  _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$1;
+}>;
+/**
+ * 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$1, 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$1, 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
  */
@@ -1635,6 +2137,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$1, httpRequest: HttpRequest);
@@ -1642,12 +2155,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 {
@@ -1658,20 +2180,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 {
@@ -2267,6 +2799,10 @@ declare class ObservableSanityClient$1 {
   agent: {
     action: ObservableAgentsActionClient;
   };
+  collaboration: {
+    /** @alpha */
+    comments: ObservableCollaborationCommentsClient;
+  };
   functions: ObservableFunctionsClient;
   releases: ObservableReleasesClient;
   /**
@@ -2897,6 +3433,10 @@ declare class SanityClient$1 {
   agent: {
     action: AgentActionsClient;
   };
+  collaboration: {
+    /** @alpha */
+    comments: CollaborationCommentsClient;
+  };
   functions: FunctionsClient;
   releases: ReleasesClient;
   /**
@@ -4025,6 +4565,16 @@ interface ClientConfig$1 {
    * 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$1 extends ClientConfig$1 {
@@ -4506,8 +5056,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';
@@ -4646,6 +5201,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.
  *
@@ -5736,5 +6460,5 @@ interface MediaLibraryAssetDocument {
   parent?: SanityReference | null;
   rootDirectory?: Any$1;
 }
-export { EditAction as $, VersionAction as $n, PromptRequest as $r, ReconnectEvent as $t, ContentSourceMapMappings as A, SingleMutationResult as An, DatasetsClient as Ar, MultipleActionResult as At, CurrentSanityUser as B, TransactionMutationOptions as Bn, LiveClient as Br, PartialExcept as Bt, ContentSourceMap$1 as C, SanityProject as Cn, UsersClient as Cr, LiveEventRestart as Ct, ContentSourceMapDocuments$1 as D, SanityUser as Dn, ObservableMediaLibraryVideoClient as Dr, MediaLibraryAssetVersion as Dt, ContentSourceMapDocumentValueSource as E, SanityReference as En, MediaLibraryVideoClient as Er, MediaLibraryAssetInstanceIdentifier as Et, ContentSourceMapValueMapping as F, ThumbnailTransformOptions as Fn, PatchBuilder as Fr, MutationEvent as Ft, DatasetsResponse as G, UnpublishVersionAction as Gn, TranslateTarget as Gr, PublishReleaseAction as Gt, DatasetCreateOptions as H, UnfilteredResponseQueryOptions as Hn, AssetsClient as Hr, PatchOperations as Ht, CreateAction as I, TransactionAllDocumentIdsMutationOptions as In, Transaction as Ir, MutationOperation as It, DeleteVariantDefinitionAction as J, UploadClientConfig as Jn, TransformDocument as Jr, QueryParseError as Jt, DeleteAction as K, UnscheduleReleaseAction as Kn, TranslateTargetInclude as Kr, QueryOptions as Kt, CreateReleaseAction as L, TransactionAllDocumentsMutationOptions as Ln, BasePatch as Lr, MutationSelection as Lt, ContentSourceMapRemoteDocument as M, StillImageFormat as Mn, BaseTransaction as Mr, Mutation as Mt, ContentSourceMapSource as N, StoryboardTransformOptions as Nn, ObservablePatchBuilder as Nr, MutationError as Nt, ContentSourceMapLiteralSource as O, ScheduleReleaseAction as On, InvokeFunctionEvent as Or, MediaLibraryPlaybackInfoOptions as Ot, ContentSourceMapUnknownSource as P, SyncTag as Pn, ObservableTransaction as Pr, MutationErrorItem as Pt, EXPERIMENTAL_API_WARNING as Q, VariantDefinitionAction as Qn, TransformTargetInclude as Qr, RawRequestOptions as Qt, CreateVariantDefinitionAction as R, TransactionFirstDocumentIdMutationOptions as Rn, ObservablePatch as Rr, MutationSelectionQueryParams as Rt, ClientVariantConditions as S, SanityImagePalette as Sn, ObservableUsersClient as Sr, LiveEventReconnect as St, ContentSourceMapDocumentBase as T, SanityQueries as Tn, ProjectsClient as Tr, MediaLibraryAssetDocument as Tt, DatasetEditOptions as U, UnfilteredResponseWithoutQuery as Un, ObservableAssetsClient as Ur, PatchSelection as Ut, DatasetAclMode as V, UnarchiveReleaseAction as Vn, _listen as Vr, PatchMutationOperation as Vt, DatasetResponse as W, UnpublishAction as Wn, TranslateDocument as Wr, PublishAction as Wt, DiscardVersionAction as X, UploadProgressEvent as Xn, TransformTarget as Xr, RawQueryResponse$1 as Xt, DiscardAction as Y, UploadEvent as Yn, TransformOperation as Yr, QueryWithoutParams as Yt, DisconnectEvent as Z, UploadResponseEvent as Zn, TransformTargetDocument as Zr, RawQuerylessQueryResponse as Zt, ChannelErrorEvent as _, ResumableListenOptions as _n, GenerateTarget as _r, ListenOptions as _t, AllDocumentsMutationOptions as a, AgentActionPath as ai, ReleaseType as an, VideoPlaybackInfoSigned as ar, ErrorProps as at, ClientReturn$1 as b, SanityDocumentStub as bn, ObservableSanityClient$1 as br, LiveEventGoAway as bt, Any$1 as c, ConstantAgentActionParam as ci, RequestHandler as cn, VideoRenditionInfoPublic as cr, FirstDocumentMutationOptions as ct, AssetMetadataType as d, GroqAgentActionParam as di, RequestOptions$1 as dn, VideoSubtitleInfoPublic as dr, IdentifiedSanityDocumentStub as dt, PatchDocument as ei, ReleaseAction as en, VideoPlaybackInfo as er, EditReleaseAction as et, AttributeSet as f, RequestUrlOptions as fn, VideoSubtitleInfoSigned as fr, ImportReleaseAction as ft, BaseMutationOptions as g, ResumableListenEventNames as gn, GenerateOperation as gr, ListenEventName as gt, BaseActionOptions as h, ResponseQueryOptions as hn, GenerateInstruction as hr, ListenEvent as ht, AllDocumentIdsMutationOptions as i, AgentActionParams as ii, ReleaseState as in, VideoPlaybackInfoPublic as ir, EmbeddingsSettingsBody as it, ContentSourceMapPaths as j, StackablePerspective as jn, ObservableDatasetsClient as jr, MultipleMutationResult as jt, ContentSourceMapMapping as k, SingleActionResult as kn, InvokeFunctionRequest as kr, MediaLibraryVideoPlaybackTransformations as kt, ApiError as l, DocumentAgentActionParam as li, RequestHandlerOptions as ln, VideoRenditionInfoSigned as lr, FitMode as lt, AuthProviderResponse as m, ResetEvent as mn, WelcomeEvent as mr, InsertPatch as mt, ActionError as n, PatchTarget as ni, ReleaseDocument as nn, VideoPlaybackInfoItemPublic as nr, EditableReleaseDocument as nt, AnimatedImageFormat as o, AgentActionPathSegment as oi, ReplaceDraftAction as on, VideoPlaybackTokens as or, FilteredResponseQueryOptions as ot, AuthProvider as p, Requester as pn, WelcomeBackEvent as pr, InitializedClientConfig$1 as pt, DeleteReleaseAction as q, UploadBody as qn, ImageDescriptionOperation as qr, QueryParams as qt, ActionErrorItem as r, AgentActionParam as ri, ReleaseId as rn, VideoPlaybackInfoItemSigned as rr, EmbeddingsSettings as rt, AnimatedTransformOptions as s, AgentActionTarget as si, ReplaceVersionAction as sn, VideoRenditionInfo as sr, FirstDocumentIdMutationOptions as st, Action as t, PatchOperation as ti, ReleaseCardinality as tn, VideoPlaybackInfoItem as tr, EditVariantDefinitionAction as tt, ArchiveReleaseAction as u, FieldAgentActionParam as ui, RequestObservableOptions as un, VideoSubtitleInfo as ur, HttpRequest as ut, ClientConfig$1 as v, SanityAssetDocument as vn, GenerateTargetDocument as vr, ListenParams as vt, ContentSourceMapDocument as w, SanityProjectMember as wn, ObservableProjectsClient as wr, LiveEventWelcome as wt, ClientVariant as x, SanityImageAssetDocument as xn, SanityClient$1 as xr, LiveEventMessage as xt, ClientPerspective$1 as y, SanityDocument$1 as yn, GenerateTargetInclude as yr, LiveEvent as yt, CreateVersionAction as z, TransactionFirstDocumentMutationOptions as zn, Patch as zr, OpenEvent as zt };
-//# sourceMappingURL=types-BODIEY7F.d.ts.map
+export { DisconnectEvent as $, UploadClientConfig as $n, CollaborationCommentMessage as $r, QueryWithoutParams as $t, ContentSourceMapMappings as A, AgentActionTarget as Ai, SanityReference as An, ObservableProjectsClient as Ar, MediaLibraryAssetVersion as At, CreateVersionAction as B, TransactionAllDocumentIdsMutationOptions as Bn, ObservablePatchBuilder as Br, MutationSelection as Bt, ContentSourceMap$1 as C, PatchDocument as Ci, SanityDocument$1 as Cn, GenerateTarget as Cr, LiveEventGoAway as Ct, ContentSourceMapDocuments$1 as D, AgentActionParams as Di, SanityProject as Dn, SanityClient$1 as Dr, LiveEventWelcome as Dt, ContentSourceMapDocumentValueSource as E, AgentActionParam as Ei, SanityImagePalette as En, ObservableSanityClient$1 as Er, LiveEventRestart as Et, ContentSourceMapValueMapping as F, StackablePerspective as Fn, InvokeFunctionOptions as Fr, Mutation as Ft, DatasetResponse as G, UnarchiveReleaseAction as Gn, ObservablePatch as Gr, PatchOperations as Gt, DatasetAclMode as H, TransactionFirstDocumentIdMutationOptions as Hn, PatchBuilder as Hr, OpenEvent as Ht, CreateAction as I, StillImageFormat as In, InvokeFunctionRequest as Ir, MutationError as It, DeleteReleaseAction as J, UnpublishAction as Jn, CollaborationCommentsClient as Jr, PublishReleaseAction as Jt, DatasetsResponse as K, UnfilteredResponseQueryOptions as Kn, Patch as Kr, PatchSelection as Kt, CreateReleaseAction as L, StoryboardTransformOptions as Ln, DatasetsClient as Lr, MutationErrorItem as Lt, ContentSourceMapRemoteDocument as M, DocumentAgentActionParam as Mi, ScheduleReleaseAction as Mn, MediaLibraryVideoClient as Mr, MediaLibraryVideoPlaybackTransformations as Mt, ContentSourceMapSource as N, FieldAgentActionParam as Ni, SingleActionResult as Nn, ObservableMediaLibraryVideoClient as Nr, MultipleActionResult as Nt, ContentSourceMapLiteralSource as O, AgentActionPath as Oi, SanityProjectMember as On, ObservableUsersClient as Or, MediaLibraryAssetDocument as Ot, ContentSourceMapUnknownSource as P, GroqAgentActionParam as Pi, SingleMutationResult as Pn, InvokeFunctionEvent as Pr, MultipleMutationResult as Pt, DiscardVersionAction as Q, UploadBody as Qn, CollaborationCommentFieldValue as Qr, QueryParseError as Qt, CreateVariantAction as R, SyncTag as Rn, ObservableDatasetsClient as Rr, MutationEvent as Rt, ClientVariantConditions as S, PromptRequest as Si, SanityAssetDocument as Sn, GenerateOperation as Sr, LiveEvent as St, ContentSourceMapDocumentBase as T, PatchTarget as Ti, SanityImageAssetDocument as Tn, GenerateTargetInclude as Tr, LiveEventReconnect as Tt, DatasetCreateOptions as U, TransactionFirstDocumentMutationOptions as Un, Transaction as Ur, PartialExcept as Ut, CurrentSanityUser as V, TransactionAllDocumentsMutationOptions as Vn, ObservableTransaction as Vr, MutationSelectionQueryParams as Vt, DatasetEditOptions as W, TransactionMutationOptions as Wn, BasePatch as Wr, PatchMutationOperation as Wt, DeleteVariantDefinitionAction as X, UnpublishVersionAction as Xn, CollaborationCommentCreate as Xr, QueryOptions as Xt, DeleteVariantAction as Y, UnpublishVariantAction as Yn, ObservableCollaborationCommentsClient as Yr, PublishVariantAction as Yt, DiscardAction as Z, UnscheduleReleaseAction as Zn, CollaborationCommentDocument as Zr, QueryParams as Zt, ChannelErrorEvent as _, TransformDocument as _i, Requester as _n, VideoSubtitleInfoPublic as _r, InsertPatch as _t, AllDocumentsMutationOptions as a, CollaborationCommentTarget as ai, ReleaseCardinality as an, VersionAction as ar, EditableReleaseDocument as at, ClientReturn$1 as b, TransformTargetDocument as bi, ResumableListenEventNames as bn, WelcomeEvent as br, ListenOptions as bt, Any$1 as c, CollaborationCommentsRequestOptions as ci, ReleaseState as cn, VideoPlaybackInfoItemPublic as cr, ErrorProps as ct, AssetMetadataType as d, AssetsClient as di, ReplaceVersionAction as dn, VideoPlaybackInfoSigned as dr, FirstDocumentMutationOptions as dt, CollaborationCommentPortableTextBlock as ei, RawQueryResponse$1 as en, UploadEvent as er, EXPERIMENTAL_API_WARNING as et, AttributeSet as f, ObservableAssetsClient as fi, RequestHandler as fn, VideoPlaybackTokens as fr, FitMode as ft, BaseMutationOptions as g, ImageDescriptionOperation as gi, RequestUrlOptions as gn, VideoSubtitleInfo as gr, InitializedClientConfig$1 as gt, BaseActionOptions as h, TranslateTargetInclude as hi, RequestOptions$1 as hn, VideoRenditionInfoSigned as hr, ImportReleaseAction as ht, AllDocumentIdsMutationOptions as i, CollaborationCommentStatus as ii, ReleaseAction as in, VariantDefinitionAction as ir, EditVariantDefinitionAction as it, ContentSourceMapPaths as j, ConstantAgentActionParam as ji, SanityUser as jn, ProjectsClient as jr, MediaLibraryPlaybackInfoOptions as jt, ContentSourceMapMapping as k, AgentActionPathSegment as ki, SanityQueries as kn, UsersClient as kr, MediaLibraryAssetInstanceIdentifier as kt, ApiError as l, CollaborationCommentsWriteOptions as li, ReleaseType as ln, VideoPlaybackInfoItemSigned as lr, FilteredResponseQueryOptions as lt, AuthProviderResponse as m, TranslateTarget as mi, RequestObservableOptions as mn, VideoRenditionInfoPublic as mr, IdentifiedSanityDocumentStub as mt, ActionError as n, CollaborationCommentReactionShortName as ni, RawRequestOptions as nn, UploadResponseEvent as nr, EditReleaseAction as nt, AnimatedImageFormat as o, CollaborationCommentUpdate as oi, ReleaseDocument as on, VideoPlaybackInfo as or, EmbeddingsSettings as ot, AuthProvider as p, TranslateDocument as pi, RequestHandlerOptions as pn, VideoRenditionInfo as pr, HttpRequest as pt, DeleteAction as q, UnfilteredResponseWithoutQuery as qn, LiveClient as qr, PublishAction as qt, ActionErrorItem as r, CollaborationCommentSelection as ri, ReconnectEvent as rn, VariantAction as rr, EditVariantAction as rt, AnimatedTransformOptions as s, CollaborationCommentsListenOptions as si, ReleaseId as sn, VideoPlaybackInfoItem as sr, EmbeddingsSettingsBody as st, Action as t, CollaborationCommentRange as ti, RawQuerylessQueryResponse as tn, UploadProgressEvent as tr, EditAction as tt, ArchiveReleaseAction as u, _listen as ui, ReplaceDraftAction as un, VideoPlaybackInfoPublic as ur, FirstDocumentIdMutationOptions as ut, ClientConfig$1 as v, TransformOperation as vi, ResetEvent as vn, VideoSubtitleInfoSigned as vr, ListenEvent as vt, ContentSourceMapDocument as w, PatchOperation as wi, SanityDocumentStub as wn, GenerateTargetDocument as wr, LiveEventMessage as wt, ClientVariant as x, TransformTargetInclude as xi, ResumableListenOptions as xn, GenerateInstruction as xr, ListenParams as xt, ClientPerspective$1 as y, TransformTarget as yi, ResponseQueryOptions as yn, WelcomeBackEvent as yr, ListenEventName as yt, CreateVariantDefinitionAction as z, ThumbnailTransformOptions as zn, BaseTransaction as zr, MutationOperation as zt };
+//# sourceMappingURL=types-0x2hPfhJ.d.ts.map