@sanity/client 6.29.1 → 7.0.1-canary.0

package/dist/index.d.cts

@@ -1459,16 +1459,13 @@ export declare class ObservableProjectsClient {
 }
 
 /** @public */
-export declare class ObservableSanityClient {
+export declare class ObservableSanityClient implements ObservableSanityClientType {
   #private
   assets: ObservableAssetsClient
   datasets: ObservableDatasetsClient
   live: LiveClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
-  /**
-   * Instance properties
-   */
   listen: typeof _listen
   constructor(httpRequest: HttpRequest, config?: ClientConfig)
   /**
@@ -1527,7 +1524,7 @@ export declare class ObservableSanityClient {
     Q extends QueryWithoutParams | QueryParams = QueryParams,
     const G extends string = string,
   >(
-    query: string,
+    query: G,
     params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
     options: UnfilteredResponseQueryOptions,
   ): Observable<RawQueryResponse<ClientReturn<G, R>>>
@@ -1962,138 +1959,630 @@ export declare class ObservableSanityClient {
   getDataUrl(operation: string, path?: string): string
 }
 
-/** @public */
-export declare class ObservableTransaction extends BaseTransaction {
-  #private
-  constructor(operations?: Mutation[], client?: ObservableSanityClient, transactionId?: string)
+/**
+ * The interface implemented by the `ObservableSanityClient` class.
+ * When writing code that wants to take an instance of `ObservableSanityClient` as input it's better to use this type,
+ * as the `ObservableSanityClient` class has private properties and thus TypeScrict will consider the type incompatible
+ * in cases where you might have multiple `@sanity/client` instances in your node_modules.
+ * @public
+ */
+export declare interface ObservableSanityClientType extends SanityClientBase {
+  assets: ObservableAssetsClient
+  datasets: ObservableDatasetsClient
+  projects: ObservableProjectsClient
+  users: ObservableUsersClient
   /**
-   * Clones the transaction
+   * Clone the client - returns a new instance
    */
-  clone(): ObservableTransaction
+  clone(): ObservableSanityClient
   /**
-   * Commit the transaction, returning an observable that produces the first mutated document
+   * Clone the client with a new (partial) configuration.
    *
-   * @param options - Options for the mutation operation
+   * @param newConfig - New client configuration properties, shallowly merged with existing configuration
    */
-  commit<R extends Record<string, Any>>(
-    options: TransactionFirstDocumentMutationOptions,
-  ): Observable<SanityDocument<R>>
+  withConfig(newConfig?: Partial<ClientConfig>): ObservableSanityClient
   /**
-   * Commit the transaction, returning an observable that produces an array of the mutated documents
+   * Perform a GROQ-query against the configured dataset.
    *
-   * @param options - Options for the mutation operation
+   * @param query - GROQ-query to perform
    */
-  commit<R extends Record<string, Any>>(
-    options: TransactionAllDocumentsMutationOptions,
-  ): Observable<SanityDocument<R>[]>
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams = QueryWithoutParams,
+    const G extends string = string,
+  >(
+    query: G,
+    params?: Q | QueryWithoutParams,
+  ): Observable<ClientReturn<G, R>>
   /**
-   * Commit the transaction, returning an observable that produces a mutation result object
+   * Perform a GROQ-query against the configured dataset.
    *
-   * @param options - Options for the mutation operation
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Optional request options
    */
-  commit(options: TransactionFirstDocumentIdMutationOptions): Observable<SingleMutationResult>
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
+    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
+    options?: FilteredResponseQueryOptions,
+  ): Observable<ClientReturn<G, R>>
   /**
-   * Commit the transaction, returning an observable that produces a mutation result object
+   * Perform a GROQ-query against the configured dataset.
    *
-   * @param options - Options for the mutation operation
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Request options
    */
-  commit(options: TransactionAllDocumentIdsMutationOptions): Observable<MultipleMutationResult>
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
+    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
+    options: UnfilteredResponseQueryOptions,
+  ): Observable<RawQueryResponse<ClientReturn<G, R>>>
   /**
-   * Commit the transaction, returning an observable that produces a mutation result object
+   * Perform a GROQ-query against the configured dataset.
    *
-   * @param options - Options for the mutation operation
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Request options
    */
-  commit(options?: BaseMutationOptions): Observable<MultipleMutationResult>
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
+    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
+    options: UnfilteredResponseWithoutQuery,
+  ): Observable<RawQuerylessQueryResponse<ClientReturn<G, R>>>
   /**
-   * Performs a patch on the given document ID. Can either be a builder function or an object of patch operations.
-   * The operation is added to the current transaction, ready to be commited by `commit()`
+   * Fetch a single document with the given ID.
    *
-   * @param documentId - Document ID to perform the patch operation on
-   * @param patchOps - Operations to perform, or a builder function
+   * @param id - Document ID to fetch
+   * @param options - Request options
    */
-  patch(documentId: string, patchOps?: ObservablePatchBuilder | PatchOperations): this
+  getDocument<R extends Record<string, Any> = Record<string, Any>>(
+    id: string,
+    options?: {
+      tag?: string
+    },
+  ): Observable<SanityDocument<R> | undefined>
   /**
-   * Adds the given patch instance to the transaction.
-   * The operation is added to the current transaction, ready to be commited by `commit()`
+   * Fetch multiple documents in one request.
+   * Should be used sparingly - performing a query is usually a better option.
+   * The order/position of documents is preserved based on the original array of IDs.
+   * If any of the documents are missing, they will be replaced by a `null` entry in the returned array
    *
-   * @param patch - ObservablePatch to execute
+   * @param ids - Document IDs to fetch
+   * @param options - Request options
    */
-  patch(patch: ObservablePatch): this
-}
-
-/** @public */
-export declare class ObservableUsersClient {
-  #private
-  constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
+  getDocuments<R extends Record<string, Any> = Record<string, Any>>(
+    ids: string[],
+    options?: {
+      tag?: string
+    },
+  ): Observable<(SanityDocument<R> | null)[]>
   /**
-   * Fetch a user by user ID
+   * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
+   * Returns an observable that resolves to the created document.
    *
-   * @param id - User ID of the user to fetch. If `me` is provided, a minimal response including the users role is returned.
+   * @param document - Document to create
+   * @param options - Mutation options
    */
-  getById<T extends 'me' | string>(
-    id: T,
-  ): Observable<T extends 'me' ? CurrentSanityUser : SanityUser>
-}
-
-/**
- * The listener connection has been established
- * note: it's usually a better option to use the 'welcome' event
- * @public
- */
-export declare type OpenEvent = {
-  type: 'open'
-}
-
-/** @public */
-export declare class Patch extends BasePatch {
-  #private
-  constructor(selection: PatchSelection, operations?: PatchOperations, client?: SanityClient)
+  create<R extends Record<string, Any> = Record<string, Any>>(
+    document: SanityDocumentStub<R>,
+    options: FirstDocumentMutationOptions,
+  ): Observable<SanityDocument<R>>
   /**
-   * Clones the patch
+   * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
+   * Returns an observable that resolves to an array containing the created document.
+   *
+   * @param document - Document to create
+   * @param options - Mutation options
    */
-  clone(): Patch
+  create<R extends Record<string, Any> = Record<string, Any>>(
+    document: SanityDocumentStub<R>,
+    options: AllDocumentsMutationOptions,
+  ): Observable<SanityDocument<R>[]>
   /**
-   * Commit the patch, returning a promise that resolves to the first patched document
+   * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
+   * Returns an observable that resolves to a mutation result object containing the ID of the created document.
    *
-   * @param options - Options for the mutation operation
+   * @param document - Document to create
+   * @param options - Mutation options
    */
-  commit<R extends Record<string, Any> = Record<string, Any>>(
+  create<R extends Record<string, Any> = Record<string, Any>>(
+    document: SanityDocumentStub<R>,
+    options: FirstDocumentIdMutationOptions,
+  ): Observable<SingleMutationResult>
+  /**
+   * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
+   * Returns an observable that resolves to a mutation result object containing the ID of the created document.
+   *
+   * @param document - Document to create
+   * @param options - Mutation options
+   */
+  create<R extends Record<string, Any> = Record<string, Any>>(
+    document: SanityDocumentStub<R>,
+    options: AllDocumentIdsMutationOptions,
+  ): Observable<MultipleMutationResult>
+  /**
+   * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
+   * Returns an observable that resolves to the created document.
+   *
+   * @param document - Document to create
+   * @param options - Mutation options
+   */
+  create<R extends Record<string, Any> = Record<string, Any>>(
+    document: SanityDocumentStub<R>,
+    options?: BaseMutationOptions,
+  ): Observable<SanityDocument<R>>
+  /**
+   * Create a document if no document with the same ID already exists.
+   * Returns an observable that resolves to the created document.
+   *
+   * @param document - Document to create
+   * @param options - Mutation options
+   */
+  createIfNotExists<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
     options: FirstDocumentMutationOptions,
-  ): Promise<SanityDocument<R>>
+  ): Observable<SanityDocument<R>>
   /**
-   * Commit the patch, returning a promise that resolves to an array of the mutated documents
+   * Create a document if no document with the same ID already exists.
+   * Returns an observable that resolves to an array containing the created document.
    *
-   * @param options - Options for the mutation operation
+   * @param document - Document to create
+   * @param options - Mutation options
    */
-  commit<R extends Record<string, Any> = Record<string, Any>>(
+  createIfNotExists<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
     options: AllDocumentsMutationOptions,
-  ): Promise<SanityDocument<R>[]>
+  ): Observable<SanityDocument<R>[]>
   /**
-   * Commit the patch, returning a promise that resolves to a mutation result object
+   * Create a document if no document with the same ID already exists.
+   * Returns an observable that resolves to a mutation result object containing the ID of the created document.
    *
-   * @param options - Options for the mutation operation
+   * @param document - Document to create
+   * @param options - Mutation options
    */
-  commit(options: FirstDocumentIdMutationOptions): Promise<SingleMutationResult>
+  createIfNotExists<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options: FirstDocumentIdMutationOptions,
+  ): Observable<SingleMutationResult>
   /**
-   * Commit the patch, returning a promise that resolves to a mutation result object
+   * Create a document if no document with the same ID already exists.
+   * Returns an observable that resolves to a mutation result object containing the ID of the created document.
    *
-   * @param options - Options for the mutation operation
+   * @param document - Document to create
+   * @param options - Mutation options
    */
-  commit(options: AllDocumentIdsMutationOptions): Promise<MultipleMutationResult>
+  createIfNotExists<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options: AllDocumentIdsMutationOptions,
+  ): Observable<MultipleMutationResult>
   /**
-   * Commit the patch, returning a promise that resolves to the first patched document
+   * Create a document if no document with the same ID already exists.
+   * Returns an observable that resolves to the created document.
    *
-   * @param options - Options for the mutation operation
+   * @param document - Document to create
+   * @param options - Mutation options
    */
-  commit<R extends Record<string, Any> = Record<string, Any>>(
+  createIfNotExists<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
     options?: BaseMutationOptions,
-  ): Promise<SanityDocument<R>>
-}
-
-/** @public */
-export declare type PatchBuilder = (patch: Patch) => Patch
-
-/** @internal */
+  ): Observable<SanityDocument<R>>
+  /**
+   * Create a document if it does not exist, or replace a document with the same document ID
+   * Returns an observable that resolves to the created document.
+   *
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
+   */
+  createOrReplace<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options: FirstDocumentMutationOptions,
+  ): Observable<SanityDocument<R>>
+  /**
+   * Create a document if it does not exist, or replace a document with the same document ID
+   * Returns an observable that resolves to an array containing the created document.
+   *
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
+   */
+  createOrReplace<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options: AllDocumentsMutationOptions,
+  ): Observable<SanityDocument<R>[]>
+  /**
+   * Create a document if it does not exist, or replace a document with the same document ID
+   * Returns an observable that resolves to a mutation result object containing the ID of the created document.
+   *
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
+   */
+  createOrReplace<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options: FirstDocumentIdMutationOptions,
+  ): Observable<SingleMutationResult>
+  /**
+   * Create a document if it does not exist, or replace a document with the same document ID
+   * Returns an observable that resolves to a mutation result object containing the created document ID.
+   *
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
+   */
+  createOrReplace<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options: AllDocumentIdsMutationOptions,
+  ): Observable<MultipleMutationResult>
+  /**
+   * Create a document if it does not exist, or replace a document with the same document ID
+   * Returns an observable that resolves to the created document.
+   *
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
+   */
+  createOrReplace<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options?: BaseMutationOptions,
+  ): Observable<SanityDocument<R>>
+  /**
+   * Deletes a document with the given document ID.
+   * Returns an observable that resolves to the deleted document.
+   *
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
+   */
+  delete<R extends Record<string, Any> = Record<string, Any>>(
+    id: string,
+    options: FirstDocumentMutationOptions,
+  ): Observable<SanityDocument<R>>
+  /**
+   * Deletes a document with the given document ID.
+   * Returns an observable that resolves to an array containing the deleted document.
+   *
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
+   */
+  delete<R extends Record<string, Any> = Record<string, Any>>(
+    id: string,
+    options: AllDocumentsMutationOptions,
+  ): Observable<SanityDocument<R>[]>
+  /**
+   * Deletes a document with the given document ID.
+   * Returns an observable that resolves to a mutation result object containing the deleted document ID.
+   *
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
+   */
+  delete(id: string, options: FirstDocumentIdMutationOptions): Observable<SingleMutationResult>
+  /**
+   * Deletes a document with the given document ID.
+   * Returns an observable that resolves to a mutation result object containing the deleted document ID.
+   *
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
+   */
+  delete(id: string, options: AllDocumentIdsMutationOptions): Observable<MultipleMutationResult>
+  /**
+   * Deletes a document with the given document ID.
+   * Returns an observable that resolves to the deleted document.
+   *
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
+   */
+  delete<R extends Record<string, Any> = Record<string, Any>>(
+    id: string,
+    options?: BaseMutationOptions,
+  ): Observable<SanityDocument<R>>
+  /**
+   * Deletes one or more documents matching the given query or document ID.
+   * Returns an observable that resolves to first deleted document.
+   *
+   * @param selection - An object with either an `id` or `query` key defining what to delete
+   * @param options - Options for the mutation
+   */
+  delete<R extends Record<string, Any> = Record<string, Any>>(
+    selection: MutationSelection,
+    options: FirstDocumentMutationOptions,
+  ): Observable<SanityDocument<R>>
+  /**
+   * Deletes one or more documents matching the given query or document ID.
+   * Returns an observable that resolves to an array containing the deleted documents.
+   *
+   * @param selection - An object with either an `id` or `query` key defining what to delete
+   * @param options - Options for the mutation
+   */
+  delete<R extends Record<string, Any> = Record<string, Any>>(
+    selection: MutationSelection,
+    options: AllDocumentsMutationOptions,
+  ): Observable<SanityDocument<R>[]>
+  /**
+   * Deletes one or more documents matching the given query or document ID.
+   * Returns an observable that resolves to a mutation result object containing the ID of the first deleted document.
+   *
+   * @param selection - An object with either an `id` or `query` key defining what to delete
+   * @param options - Options for the mutation
+   */
+  delete(
+    selection: MutationSelection,
+    options: FirstDocumentIdMutationOptions,
+  ): Observable<SingleMutationResult>
+  /**
+   * Deletes one or more documents matching the given query or document ID.
+   * Returns an observable that resolves to a mutation result object containing the document IDs that were deleted.
+   *
+   * @param selection - An object with either an `id` or `query` key defining what to delete
+   * @param options - Options for the mutation
+   */
+  delete(
+    selection: MutationSelection,
+    options: AllDocumentIdsMutationOptions,
+  ): Observable<MultipleMutationResult>
+  /**
+   * Deletes one or more documents matching the given query or document ID.
+   * Returns an observable that resolves to first deleted document.
+   *
+   * @param selection - An object with either an `id` or `query` key defining what to delete
+   * @param options - Options for the mutation
+   */
+  delete<R extends Record<string, Any> = Record<string, Any>>(
+    selection: MutationSelection,
+    options?: BaseMutationOptions,
+  ): Observable<SanityDocument<R>>
+  /**
+   * Perform mutation operations against the configured dataset
+   * Returns an observable that resolves to the first mutated document.
+   *
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
+   */
+  mutate<R extends Record<string, Any> = Record<string, Any>>(
+    operations: Mutation<R>[] | ObservablePatch | ObservableTransaction,
+    options: FirstDocumentMutationOptions,
+  ): Observable<SanityDocument<R>>
+  /**
+   * Perform mutation operations against the configured dataset.
+   * Returns an observable that resolves to an array of the mutated documents.
+   *
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
+   */
+  mutate<R extends Record<string, Any> = Record<string, Any>>(
+    operations: Mutation<R>[] | ObservablePatch | ObservableTransaction,
+    options: AllDocumentsMutationOptions,
+  ): Observable<SanityDocument<R>[]>
+  /**
+   * Perform mutation operations against the configured dataset
+   * Returns an observable that resolves to a mutation result object containing the document ID of the first mutated document.
+   *
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
+   */
+  mutate<R extends Record<string, Any> = Record<string, Any>>(
+    operations: Mutation<R>[] | ObservablePatch | ObservableTransaction,
+    options: FirstDocumentIdMutationOptions,
+  ): Observable<SingleMutationResult>
+  /**
+   * Perform mutation operations against the configured dataset
+   * Returns an observable that resolves to a mutation result object containing the mutated document IDs.
+   *
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
+   */
+  mutate<R extends Record<string, Any> = Record<string, Any>>(
+    operations: Mutation<R>[] | ObservablePatch | ObservableTransaction,
+    options: AllDocumentIdsMutationOptions,
+  ): Observable<MultipleMutationResult>
+  /**
+   * Perform mutation operations against the configured dataset
+   * Returns an observable that resolves to the first mutated document.
+   *
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
+   */
+  mutate<R extends Record<string, Any> = Record<string, Any>>(
+    operations: Mutation<R>[] | ObservablePatch | ObservableTransaction,
+    options?: BaseMutationOptions,
+  ): Observable<SanityDocument<R>>
+  /**
+   * Create a new buildable patch of operations to perform
+   *
+   * @param documentId - Document ID to patch
+   * @param operations - Optional object of patch operations to initialize the patch instance with
+   * @returns Patch instance - call `.commit()` to perform the operations defined
+   */
+  patch(documentId: string, operations?: PatchOperations): ObservablePatch
+  /**
+   * Create a new buildable patch of operations to perform
+   *
+   * @param documentIds - Array of document IDs to patch
+   * @param operations - Optional object of patch operations to initialize the patch instance with
+   * @returns Patch instance - call `.commit()` to perform the operations defined
+   */
+  patch(documentIds: string[], operations?: PatchOperations): ObservablePatch
+  /**
+   * Create a new buildable patch of operations to perform
+   *
+   * @param selection - An object with `query` and optional `params`, defining which document(s) to patch
+   * @param operations - Optional object of patch operations to initialize the patch instance with
+   * @returns Patch instance - call `.commit()` to perform the operations defined
+   */
+  patch(selection: MutationSelection, operations?: PatchOperations): ObservablePatch
+  /**
+   * Create a new buildable patch of operations to perform
+   *
+   * @param selection - Document ID, an array of document IDs, or an object with `query` and optional `params`, defining which document(s) to patch
+   * @param operations - Optional object of patch operations to initialize the patch instance with
+   * @returns Patch instance - call `.commit()` to perform the operations defined
+   */
+  patch(selection: PatchSelection, operations?: PatchOperations): ObservablePatch
+  /**
+   * Create a new transaction of mutations
+   *
+   * @param operations - Optional array of mutation operations to initialize the transaction instance with
+   */
+  transaction<R extends Record<string, Any> = Record<string, Any>>(
+    operations?: Mutation<R>[],
+  ): ObservableTransaction
+  /**
+   * Perform action operations against the configured dataset
+   *
+   * @param operations - Action operation(s) to execute
+   * @param options - Action options
+   */
+  action(
+    operations: Action | Action[],
+    options?: BaseActionOptions,
+  ): Observable<SingleActionResult | MultipleActionResult>
+  /**
+   * Perform an HTTP request against the Sanity API
+   *
+   * @param options - Request options
+   */
+  request<R = Any>(options: RawRequestOptions): Observable<R>
+}
+
+/** @public */
+export declare class ObservableTransaction extends BaseTransaction {
+  #private
+  constructor(operations?: Mutation[], client?: ObservableSanityClient, transactionId?: string)
+  /**
+   * Clones the transaction
+   */
+  clone(): ObservableTransaction
+  /**
+   * Commit the transaction, returning an observable that produces the first mutated document
+   *
+   * @param options - Options for the mutation operation
+   */
+  commit<R extends Record<string, Any>>(
+    options: TransactionFirstDocumentMutationOptions,
+  ): Observable<SanityDocument<R>>
+  /**
+   * Commit the transaction, returning an observable that produces an array of the mutated documents
+   *
+   * @param options - Options for the mutation operation
+   */
+  commit<R extends Record<string, Any>>(
+    options: TransactionAllDocumentsMutationOptions,
+  ): Observable<SanityDocument<R>[]>
+  /**
+   * Commit the transaction, returning an observable that produces a mutation result object
+   *
+   * @param options - Options for the mutation operation
+   */
+  commit(options: TransactionFirstDocumentIdMutationOptions): Observable<SingleMutationResult>
+  /**
+   * Commit the transaction, returning an observable that produces a mutation result object
+   *
+   * @param options - Options for the mutation operation
+   */
+  commit(options: TransactionAllDocumentIdsMutationOptions): Observable<MultipleMutationResult>
+  /**
+   * Commit the transaction, returning an observable that produces a mutation result object
+   *
+   * @param options - Options for the mutation operation
+   */
+  commit(options?: BaseMutationOptions): Observable<MultipleMutationResult>
+  /**
+   * Performs a patch on the given document ID. Can either be a builder function or an object of patch operations.
+   * The operation is added to the current transaction, ready to be commited by `commit()`
+   *
+   * @param documentId - Document ID to perform the patch operation on
+   * @param patchOps - Operations to perform, or a builder function
+   */
+  patch(documentId: string, patchOps?: ObservablePatchBuilder | PatchOperations): this
+  /**
+   * Adds the given patch instance to the transaction.
+   * The operation is added to the current transaction, ready to be commited by `commit()`
+   *
+   * @param patch - ObservablePatch to execute
+   */
+  patch(patch: ObservablePatch): this
+}
+
+/** @public */
+export declare class ObservableUsersClient {
+  #private
+  constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
+  /**
+   * Fetch a user by user ID
+   *
+   * @param id - User ID of the user to fetch. If `me` is provided, a minimal response including the users role is returned.
+   */
+  getById<T extends 'me' | string>(
+    id: T,
+  ): Observable<T extends 'me' ? CurrentSanityUser : SanityUser>
+}
+
+/**
+ * The listener connection has been established
+ * note: it's usually a better option to use the 'welcome' event
+ * @public
+ */
+export declare type OpenEvent = {
+  type: 'open'
+}
+
+/** @public */
+export declare class Patch extends BasePatch {
+  #private
+  constructor(selection: PatchSelection, operations?: PatchOperations, client?: SanityClient)
+  /**
+   * Clones the patch
+   */
+  clone(): Patch
+  /**
+   * Commit the patch, returning a promise that resolves to the first patched document
+   *
+   * @param options - Options for the mutation operation
+   */
+  commit<R extends Record<string, Any> = Record<string, Any>>(
+    options: FirstDocumentMutationOptions,
+  ): Promise<SanityDocument<R>>
+  /**
+   * Commit the patch, returning a promise that resolves to an array of the mutated documents
+   *
+   * @param options - Options for the mutation operation
+   */
+  commit<R extends Record<string, Any> = Record<string, Any>>(
+    options: AllDocumentsMutationOptions,
+  ): Promise<SanityDocument<R>[]>
+  /**
+   * Commit the patch, returning a promise that resolves to a mutation result object
+   *
+   * @param options - Options for the mutation operation
+   */
+  commit(options: FirstDocumentIdMutationOptions): Promise<SingleMutationResult>
+  /**
+   * Commit the patch, returning a promise that resolves to a mutation result object
+   *
+   * @param options - Options for the mutation operation
+   */
+  commit(options: AllDocumentIdsMutationOptions): Promise<MultipleMutationResult>
+  /**
+   * Commit the patch, returning a promise that resolves to the first patched document
+   *
+   * @param options - Options for the mutation operation
+   */
+  commit<R extends Record<string, Any> = Record<string, Any>>(
+    options?: BaseMutationOptions,
+  ): Promise<SanityDocument<R>>
+}
+
+/** @public */
+export declare type PatchBuilder = (patch: Patch) => Patch
+
+/** @internal */
 export declare type PatchMutationOperation = PatchOperations & MutationSelection
 
 /** @internal */
@@ -2137,275 +2626,818 @@ export declare class ProjectsClient {
   #private
   constructor(client: SanityClient, httpRequest: HttpRequest)
   /**
-   * Fetch a list of projects the authenticated user has access to.
+   * Fetch a list of projects the authenticated user has access to.
+   *
+   * @param options - Options for the list request
+   * @param options.includeMembers - Whether to include members in the response (default: true)
+   */
+  list(options?: {includeMembers?: true}): Promise<SanityProject[]>
+  list(options?: {includeMembers?: false}): Promise<Omit<SanityProject, 'members'>[]>
+  /**
+   * Fetch a project by project ID
+   *
+   * @param projectId - ID of the project to fetch
+   */
+  getById(projectId: string): Promise<SanityProject>
+}
+
+/**
+ * Publishes a draft document.
+ * If a published version of the document already exists this is replaced by the current draft document.
+ * In either case the draft document is deleted.
+ * The optional revision id parameters can be used for optimistic locking to ensure
+ * that the draft and/or published versions of the document have not been changed by another client.
+ *
+ * @public
+ */
+export declare type PublishAction = {
+  actionType: 'sanity.action.document.publish'
+  /**
+   * Draft document ID to publish
+   */
+  draftId: string
+  /**
+   * Draft revision ID to match
+   */
+  ifDraftRevisionId?: string
+  /**
+   * Published document ID to replace
+   */
+  publishedId: string
+  /**
+   * Published revision ID to match
+   */
+  ifPublishedRevisionId?: string
+}
+
+/** @public */
+export declare type QueryOptions =
+  | FilteredResponseQueryOptions
+  | UnfilteredResponseQueryOptions
+  | UnfilteredResponseWithoutQuery
+
+/** @public */
+export declare interface QueryParams {
+  [key: string]: any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  body?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  cache?: 'next' extends keyof RequestInit ? never : any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  filterResponse?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  headers?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  method?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  next?: 'next' extends keyof RequestInit ? never : any
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  perspective?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  query?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  resultSourceMap?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  returnQuery?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  signal?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  stega?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  tag?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  timeout?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  token?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  useCdn?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  lastLiveEventId?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  cacheMode?: never
+}
+
+/**
+ * This type can be used with `client.fetch` to indicate that the query has no GROQ parameters.
+ * @public
+ */
+export declare type QueryWithoutParams = Record<string, never> | undefined
+
+/** @public */
+export declare type RawQuerylessQueryResponse<R> = Omit<RawQueryResponse<R>, 'query'>
+
+/** @public */
+export declare interface RawQueryResponse<R> {
+  query: string
+  ms: number
+  result: R
+  resultSourceMap?: ContentSourceMap
+  /** Requires `apiVersion` to be `2021-03-25` or later. */
+  syncTags?: SyncTag[]
+}
+
+/** @internal */
+export declare interface RawRequestOptions {
+  url?: string
+  uri?: string
+  method?: string
+  token?: string
+  json?: boolean
+  tag?: string
+  useGlobalApi?: boolean
+  withCredentials?: boolean
+  query?: {
+    [key: string]: string | string[]
+  }
+  headers?: {
+    [key: string]: string
+  }
+  timeout?: number
+  proxy?: string
+  body?: Any
+  maxRedirects?: number
+  signal?: AbortSignal
+}
+
+/**
+ * The listener has been disconnected, and a reconnect attempt is scheduled.
+ *
+ * @public
+ */
+export declare type ReconnectEvent = {
+  type: 'reconnect'
+}
+
+/**
+ * @public
+ * @deprecated – The `r`-prefix is not required, use `string` instead
+ */
+export declare type ReleaseId = `r${string}`
+
+/**
+ * Replaces an existing draft document.
+ * At least one of the draft or published versions of the document must exist.
+ *
+ * @public
+ */
+export declare type ReplaceDraftAction = {
+  actionType: 'sanity.action.document.replaceDraft'
+  /**
+   * Published document ID to create draft from, if draft does not exist
+   */
+  publishedId: string
+  /**
+   * Document to create if it does not already exist. Requires `_id` and `_type` properties.
+   */
+  attributes: IdentifiedSanityDocumentStub
+}
+
+/** @public */
+export declare const requester: Requester
+
+/** @internal */
+export declare interface RequestObservableOptions extends Omit<RequestOptions, 'url'> {
+  url?: string
+  uri?: string
+  canUseCdn?: boolean
+  useCdn?: boolean
+  tag?: string
+  returnQuery?: boolean
+  resultSourceMap?: boolean | 'withKeyArraySelector'
+  perspective?: ClientPerspective
+  lastLiveEventId?: string
+  cacheMode?: 'noStale'
+}
+
+/** @public */
+export declare interface RequestOptions {
+  timeout?: number
+  token?: string
+  tag?: string
+  headers?: Record<string, string>
+  method?: string
+  query?: Any
+  body?: Any
+  signal?: AbortSignal
+}
+
+export {ResolveStudioUrl}
+
+/** @public */
+export declare interface ResponseEvent<T = unknown> {
+  type: 'response'
+  body: T
+  url: string
+  method: string
+  statusCode: number
+  statusMessage?: string
+  headers: Record<string, string>
+}
+
+/** @public */
+export declare interface ResponseQueryOptions extends RequestOptions {
+  perspective?: ClientPerspective
+  resultSourceMap?: boolean | 'withKeyArraySelector'
+  returnQuery?: boolean
+  useCdn?: boolean
+  stega?: boolean | StegaConfig
+  cache?: 'next' extends keyof RequestInit ? RequestInit['cache'] : never
+  next?: ('next' extends keyof RequestInit ? RequestInit : never)['next']
+  lastLiveEventId?: string | string[] | null
+  /**
+   * When set to `noStale`, APICDN will not return a cached response if the content is stale.
+   * Tradeoff between latency and freshness of content.
+   *
+   * Only to be used with live content queries and when useCdn is true.
+   */
+  cacheMode?: 'noStale'
+}
+
+/** @internal */
+export declare interface SanityAssetDocument extends SanityDocument {
+  url: string
+  path: string
+  size: number
+  assetId: string
+  mimeType: string
+  sha1hash: string
+  extension: string
+  uploadId?: string
+  originalFilename?: string
+}
+
+/** @public */
+export declare class SanityClient implements SanityClientType {
+  #private
+  assets: AssetsClient
+  datasets: DatasetsClient
+  live: LiveClient
+  projects: ProjectsClient
+  users: UsersClient
+  /**
+   * Observable version of the Sanity client, with the same configuration as the promise-based one
+   */
+  observable: ObservableSanityClient
+  listen: typeof _listen
+  constructor(httpRequest: HttpRequest, config?: ClientConfig)
+  /**
+   * Clone the client - returns a new instance
+   */
+  clone(): SanityClient
+  /**
+   * Returns the current client configuration
+   */
+  config(): InitializedClientConfig
+  /**
+   * Reconfigure the client. Note that this _mutates_ the current client.
+   */
+  config(newConfig?: Partial<ClientConfig>): this
+  /**
+   * Clone the client with a new (partial) configuration.
+   *
+   * @param newConfig - New client configuration properties, shallowly merged with existing configuration
+   */
+  withConfig(newConfig?: Partial<ClientConfig>): SanityClient
+  /**
+   * Perform a GROQ-query against the configured dataset.
+   *
+   * @param query - GROQ-query to perform
+   */
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams = QueryWithoutParams,
+    const G extends string = string,
+  >(query: G, params?: Q | QueryWithoutParams): Promise<ClientReturn<G, R>>
+  /**
+   * Perform a GROQ-query against the configured dataset.
+   *
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Optional request options
+   */
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
+    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
+    options?: FilteredResponseQueryOptions,
+  ): Promise<ClientReturn<G, R>>
+  /**
+   * Perform a GROQ-query against the configured dataset.
+   *
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Request options
+   */
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
+    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
+    options: UnfilteredResponseQueryOptions,
+  ): Promise<RawQueryResponse<ClientReturn<G, R>>>
+  /**
+   * Perform a GROQ-query against the configured dataset.
+   *
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Request options
+   */
+  fetch<
+    R = Any,
+    Q extends QueryWithoutParams | QueryParams = QueryParams,
+    const G extends string = string,
+  >(
+    query: G,
+    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
+    options: UnfilteredResponseWithoutQuery,
+  ): Promise<RawQuerylessQueryResponse<ClientReturn<G, R>>>
+  /**
+   * Fetch a single document with the given ID.
+   *
+   * @param id - Document ID to fetch
+   * @param options - Request options
+   */
+  getDocument<R extends Record<string, Any> = Record<string, Any>>(
+    id: string,
+    options?: {
+      signal?: AbortSignal
+      tag?: string
+    },
+  ): Promise<SanityDocument<R> | undefined>
+  /**
+   * Fetch multiple documents in one request.
+   * Should be used sparingly - performing a query is usually a better option.
+   * The order/position of documents is preserved based on the original array of IDs.
+   * If any of the documents are missing, they will be replaced by a `null` entry in the returned array
+   *
+   * @param ids - Document IDs to fetch
+   * @param options - Request options
+   */
+  getDocuments<R extends Record<string, Any> = Record<string, Any>>(
+    ids: string[],
+    options?: {
+      signal?: AbortSignal
+      tag?: string
+    },
+  ): Promise<(SanityDocument<R> | null)[]>
+  /**
+   * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
+   * Returns a promise that resolves to the created document.
+   *
+   * @param document - Document to create
+   * @param options - Mutation options
+   */
+  create<R extends Record<string, Any> = Record<string, Any>>(
+    document: SanityDocumentStub<R>,
+    options: FirstDocumentMutationOptions,
+  ): Promise<SanityDocument<R>>
+  /**
+   * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
+   * Returns a promise that resolves to an array containing the created document.
+   *
+   * @param document - Document to create
+   * @param options - Mutation options
+   */
+  create<R extends Record<string, Any> = Record<string, Any>>(
+    document: SanityDocumentStub<R>,
+    options: AllDocumentsMutationOptions,
+  ): Promise<SanityDocument<R>[]>
+  /**
+   * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
+   * Returns a promise that resolves to a mutation result object containing the ID of the created document.
+   *
+   * @param document - Document to create
+   * @param options - Mutation options
+   */
+  create<R extends Record<string, Any> = Record<string, Any>>(
+    document: SanityDocumentStub<R>,
+    options: FirstDocumentIdMutationOptions,
+  ): Promise<SingleMutationResult>
+  /**
+   * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
+   * Returns a promise that resolves to a mutation result object containing the ID of the created document.
+   *
+   * @param document - Document to create
+   * @param options - Mutation options
+   */
+  create<R extends Record<string, Any> = Record<string, Any>>(
+    document: SanityDocumentStub<R>,
+    options: AllDocumentIdsMutationOptions,
+  ): Promise<MultipleMutationResult>
+  /**
+   * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
+   * Returns a promise that resolves to the created document.
+   *
+   * @param document - Document to create
+   * @param options - Mutation options
+   */
+  create<R extends Record<string, Any> = Record<string, Any>>(
+    document: SanityDocumentStub<R>,
+    options?: BaseMutationOptions,
+  ): Promise<SanityDocument<R>>
+  /**
+   * Create a document if no document with the same ID already exists.
+   * Returns a promise that resolves to the created document.
+   *
+   * @param document - Document to create
+   * @param options - Mutation options
+   */
+  createIfNotExists<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options: FirstDocumentMutationOptions,
+  ): Promise<SanityDocument<R>>
+  /**
+   * Create a document if no document with the same ID already exists.
+   * Returns a promise that resolves to an array containing the created document.
+   *
+   * @param document - Document to create
+   * @param options - Mutation options
+   */
+  createIfNotExists<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options: AllDocumentsMutationOptions,
+  ): Promise<SanityDocument<R>[]>
+  /**
+   * Create a document if no document with the same ID already exists.
+   * Returns a promise that resolves to a mutation result object containing the ID of the created document.
+   *
+   * @param document - Document to create
+   * @param options - Mutation options
+   */
+  createIfNotExists<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options: FirstDocumentIdMutationOptions,
+  ): Promise<SingleMutationResult>
+  /**
+   * Create a document if no document with the same ID already exists.
+   * Returns a promise that resolves to a mutation result object containing the ID of the created document.
+   *
+   * @param document - Document to create
+   * @param options - Mutation options
+   */
+  createIfNotExists<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options: AllDocumentIdsMutationOptions,
+  ): Promise<MultipleMutationResult>
+  /**
+   * Create a document if no document with the same ID already exists.
+   * Returns a promise that resolves to the created document.
+   *
+   * @param document - Document to create
+   * @param options - Mutation options
+   */
+  createIfNotExists<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options?: BaseMutationOptions,
+  ): Promise<SanityDocument<R>>
+  /**
+   * Create a document if it does not exist, or replace a document with the same document ID
+   * Returns a promise that resolves to the created document.
+   *
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
+   */
+  createOrReplace<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options: FirstDocumentMutationOptions,
+  ): Promise<SanityDocument<R>>
+  /**
+   * Create a document if it does not exist, or replace a document with the same document ID
+   * Returns a promise that resolves to an array containing the created document.
+   *
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
+   */
+  createOrReplace<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options: AllDocumentsMutationOptions,
+  ): Promise<SanityDocument<R>[]>
+  /**
+   * Create a document if it does not exist, or replace a document with the same document ID
+   * Returns a promise that resolves to a mutation result object containing the ID of the created document.
+   *
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
+   */
+  createOrReplace<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options: FirstDocumentIdMutationOptions,
+  ): Promise<SingleMutationResult>
+  /**
+   * Create a document if it does not exist, or replace a document with the same document ID
+   * Returns a promise that resolves to a mutation result object containing the created document ID.
+   *
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
+   */
+  createOrReplace<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options: AllDocumentIdsMutationOptions,
+  ): Promise<MultipleMutationResult>
+  /**
+   * Create a document if it does not exist, or replace a document with the same document ID
+   * Returns a promise that resolves to the created document.
    *
-   * @param options - Options for the list request
-   * @param options.includeMembers - Whether to include members in the response (default: true)
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
    */
-  list(options?: {includeMembers?: true}): Promise<SanityProject[]>
-  list(options?: {includeMembers?: false}): Promise<Omit<SanityProject, 'members'>[]>
+  createOrReplace<R extends Record<string, Any> = Record<string, Any>>(
+    document: IdentifiedSanityDocumentStub<R>,
+    options?: BaseMutationOptions,
+  ): Promise<SanityDocument<R>>
   /**
-   * Fetch a project by project ID
+   * Deletes a document with the given document ID.
+   * Returns a promise that resolves to the deleted document.
    *
-   * @param projectId - ID of the project to fetch
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
    */
-  getById(projectId: string): Promise<SanityProject>
-}
-
-/**
- * Publishes a draft document.
- * If a published version of the document already exists this is replaced by the current draft document.
- * In either case the draft document is deleted.
- * The optional revision id parameters can be used for optimistic locking to ensure
- * that the draft and/or published versions of the document have not been changed by another client.
- *
- * @public
- */
-export declare type PublishAction = {
-  actionType: 'sanity.action.document.publish'
+  delete<R extends Record<string, Any> = Record<string, Any>>(
+    id: string,
+    options: FirstDocumentMutationOptions,
+  ): Promise<SanityDocument<R>>
   /**
-   * Draft document ID to publish
+   * Deletes a document with the given document ID.
+   * Returns a promise that resolves to an array containing the deleted document.
+   *
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
    */
-  draftId: string
+  delete<R extends Record<string, Any> = Record<string, Any>>(
+    id: string,
+    options: AllDocumentsMutationOptions,
+  ): Promise<SanityDocument<R>[]>
   /**
-   * Draft revision ID to match
+   * Deletes a document with the given document ID.
+   * Returns a promise that resolves to a mutation result object containing the deleted document ID.
+   *
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
    */
-  ifDraftRevisionId?: string
+  delete(id: string, options: FirstDocumentIdMutationOptions): Promise<SingleMutationResult>
   /**
-   * Published document ID to replace
+   * Deletes a document with the given document ID.
+   * Returns a promise that resolves to a mutation result object containing the deleted document ID.
+   *
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
+   */
+  delete(id: string, options: AllDocumentIdsMutationOptions): Promise<MultipleMutationResult>
+  /**
+   * Deletes a document with the given document ID.
+   * Returns a promise that resolves to the deleted document.
+   *
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
+   */
+  delete<R extends Record<string, Any> = Record<string, Any>>(
+    id: string,
+    options?: BaseMutationOptions,
+  ): Promise<SanityDocument<R>>
+  /**
+   * Deletes one or more documents matching the given query or document ID.
+   * Returns a promise that resolves to first deleted document.
+   *
+   * @param selection - An object with either an `id` or `query` key defining what to delete
+   * @param options - Options for the mutation
+   */
+  delete<R extends Record<string, Any> = Record<string, Any>>(
+    selection: MutationSelection,
+    options: FirstDocumentMutationOptions,
+  ): Promise<SanityDocument<R>>
+  /**
+   * Deletes one or more documents matching the given query or document ID.
+   * Returns a promise that resolves to an array containing the deleted documents.
+   *
+   * @param selection - An object with either an `id` or `query` key defining what to delete
+   * @param options - Options for the mutation
+   */
+  delete<R extends Record<string, Any> = Record<string, Any>>(
+    selection: MutationSelection,
+    options: AllDocumentsMutationOptions,
+  ): Promise<SanityDocument<R>[]>
+  /**
+   * Deletes one or more documents matching the given query or document ID.
+   * Returns a promise that resolves to a mutation result object containing the ID of the first deleted document.
+   *
+   * @param selection - An object with either an `id` or `query` key defining what to delete
+   * @param options - Options for the mutation
+   */
+  delete(
+    selection: MutationSelection,
+    options: FirstDocumentIdMutationOptions,
+  ): Promise<SingleMutationResult>
+  /**
+   * Deletes one or more documents matching the given query or document ID.
+   * Returns a promise that resolves to a mutation result object containing the document IDs that were deleted.
+   *
+   * @param selection - An object with either an `id` or `query` key defining what to delete
+   * @param options - Options for the mutation
+   */
+  delete(
+    selection: MutationSelection,
+    options: AllDocumentIdsMutationOptions,
+  ): Promise<MultipleMutationResult>
+  /**
+   * Deletes one or more documents matching the given query or document ID.
+   * Returns a promise that resolves to first deleted document.
+   *
+   * @param selection - An object with either an `id` or `query` key defining what to delete
+   * @param options - Options for the mutation
+   */
+  delete<R extends Record<string, Any> = Record<string, Any>>(
+    selection: MutationSelection,
+    options?: BaseMutationOptions,
+  ): Promise<SanityDocument<R>>
+  /**
+   * Perform mutation operations against the configured dataset
+   * Returns a promise that resolves to the first mutated document.
+   *
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
+   */
+  mutate<R extends Record<string, Any> = Record<string, Any>>(
+    operations: Mutation<R>[] | Patch | Transaction,
+    options: FirstDocumentMutationOptions,
+  ): Promise<SanityDocument<R>>
+  /**
+   * Perform mutation operations against the configured dataset.
+   * Returns a promise that resolves to an array of the mutated documents.
+   *
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
+   */
+  mutate<R extends Record<string, Any> = Record<string, Any>>(
+    operations: Mutation<R>[] | Patch | Transaction,
+    options: AllDocumentsMutationOptions,
+  ): Promise<SanityDocument<R>[]>
+  /**
+   * Perform mutation operations against the configured dataset
+   * Returns a promise that resolves to a mutation result object containing the document ID of the first mutated document.
+   *
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
+   */
+  mutate<R extends Record<string, Any> = Record<string, Any>>(
+    operations: Mutation<R>[] | Patch | Transaction,
+    options: FirstDocumentIdMutationOptions,
+  ): Promise<SingleMutationResult>
+  /**
+   * Perform mutation operations against the configured dataset
+   * Returns a promise that resolves to a mutation result object containing the mutated document IDs.
+   *
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
+   */
+  mutate<R extends Record<string, Any>>(
+    operations: Mutation<R>[] | Patch | Transaction,
+    options: AllDocumentIdsMutationOptions,
+  ): Promise<MultipleMutationResult>
+  /**
+   * Perform mutation operations against the configured dataset
+   * Returns a promise that resolves to the first mutated document.
+   *
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
+   */
+  mutate<R extends Record<string, Any> = Record<string, Any>>(
+    operations: Mutation<R>[] | Patch | Transaction,
+    options?: BaseMutationOptions,
+  ): Promise<SanityDocument<R>>
+  /**
+   * Create a new buildable patch of operations to perform
+   *
+   * @param documentId - Document ID to patch
+   * @param operations - Optional object of patch operations to initialize the patch instance with
+   * @returns Patch instance - call `.commit()` to perform the operations defined
+   */
+  patch(documentId: string, operations?: PatchOperations): Patch
+  /**
+   * Create a new buildable patch of operations to perform
+   *
+   * @param documentIds - Array of document IDs to patch
+   * @param operations - Optional object of patch operations to initialize the patch instance with
+   * @returns Patch instance - call `.commit()` to perform the operations defined
+   */
+  patch(documentIds: string[], operations?: PatchOperations): Patch
+  /**
+   * Create a new buildable patch of operations to perform
+   *
+   * @param selection - An object with `query` and optional `params`, defining which document(s) to patch
+   * @param operations - Optional object of patch operations to initialize the patch instance with
+   * @returns Patch instance - call `.commit()` to perform the operations defined
+   */
+  patch(selection: MutationSelection, operations?: PatchOperations): Patch
+  /**
+   * Create a new transaction of mutations
+   *
+   * @param operations - Optional array of mutation operations to initialize the transaction instance with
+   */
+  transaction<R extends Record<string, Any> = Record<string, Any>>(
+    operations?: Mutation<R>[],
+  ): Transaction
+  /**
+   * Perform action operations against the configured dataset
+   * Returns a promise that resolves to the transaction result
+   *
+   * @param operations - Action operation(s) to execute
+   * @param options - Action options
+   */
+  action(
+    operations: Action | Action[],
+    options?: BaseActionOptions,
+  ): Promise<SingleActionResult | MultipleActionResult>
+  /**
+   * Perform a request against the Sanity API
+   * NOTE: Only use this for Sanity API endpoints, not for your own APIs!
+   *
+   * @param options - Request options
+   * @returns Promise resolving to the response body
+   */
+  request<R = Any>(options: RawRequestOptions): Promise<R>
+  /**
+   * Perform an HTTP request a `/data` sub-endpoint
+   * NOTE: Considered internal, thus marked as deprecated. Use `request` instead.
+   *
+   * @deprecated - Use `request()` or your own HTTP library instead
+   * @param endpoint - Endpoint to hit (mutate, query etc)
+   * @param body - Request body
+   * @param options - Request options
+   * @internal
+   */
+  dataRequest(endpoint: string, body: unknown, options?: BaseMutationOptions): Promise<Any>
+  /**
+   * Get a Sanity API URL for the URI provided
+   *
+   * @param uri - URI/path to build URL for
+   * @param canUseCdn - Whether or not to allow using the API CDN for this route
    */
-  publishedId: string
+  getUrl(uri: string, canUseCdn?: boolean): string
   /**
-   * Published revision ID to match
+   * Get a Sanity API URL for the data operation and path provided
+   *
+   * @param operation - Data operation (eg `query`, `mutate`, `listen` or similar)
+   * @param path - Path to append after the operation
    */
-  ifPublishedRevisionId?: string
-}
-
-/** @public */
-export declare type QueryOptions =
-  | FilteredResponseQueryOptions
-  | UnfilteredResponseQueryOptions
-  | UnfilteredResponseWithoutQuery
-
-/** @public */
-export declare interface QueryParams {
-  [key: string]: any
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  body?: never
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  cache?: 'next' extends keyof RequestInit ? never : any
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  filterResponse?: never
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  headers?: never
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  method?: never
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  next?: 'next' extends keyof RequestInit ? never : any
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  perspective?: never
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  query?: never
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  resultSourceMap?: never
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  returnQuery?: never
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  signal?: never
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  stega?: never
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  tag?: never
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  timeout?: never
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  token?: never
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  useCdn?: never
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  lastLiveEventId?: never
-  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
-  cacheMode?: never
-}
-
-/**
- * This type can be used with `client.fetch` to indicate that the query has no GROQ parameters.
- * @public
- */
-export declare type QueryWithoutParams = Record<string, never> | undefined
-
-/** @public */
-export declare type RawQuerylessQueryResponse<R> = Omit<RawQueryResponse<R>, 'query'>
-
-/** @public */
-export declare interface RawQueryResponse<R> {
-  query: string
-  ms: number
-  result: R
-  resultSourceMap?: ContentSourceMap
-  /** Requires `apiVersion` to be `2021-03-25` or later. */
-  syncTags?: SyncTag[]
-}
-
-/** @internal */
-export declare interface RawRequestOptions {
-  url?: string
-  uri?: string
-  method?: string
-  token?: string
-  json?: boolean
-  tag?: string
-  useGlobalApi?: boolean
-  withCredentials?: boolean
-  query?: {
-    [key: string]: string | string[]
-  }
-  headers?: {
-    [key: string]: string
-  }
-  timeout?: number
-  proxy?: string
-  body?: Any
-  maxRedirects?: number
-  signal?: AbortSignal
-}
-
-/**
- * The listener has been disconnected, and a reconnect attempt is scheduled.
- *
- * @public
- */
-export declare type ReconnectEvent = {
-  type: 'reconnect'
+  getDataUrl(operation: string, path?: string): string
 }
 
 /**
- * @public
- * @deprecated – The `r`-prefix is not required, use `string` instead
- */
-export declare type ReleaseId = `r${string}`
-
-/**
- * Replaces an existing draft document.
- * At least one of the draft or published versions of the document must exist.
- *
- * @public
+ * Shared base type for the `SanityClient` and `ObservableSanityClient` classes.
+ * TODO: refactor the Promise and Observable differences to use generics so we no longer suffer from all this duplication in TS docs
  */
-export declare type ReplaceDraftAction = {
-  actionType: 'sanity.action.document.replaceDraft'
+declare interface SanityClientBase {
+  live: LiveClient
+  listen: typeof _listen
   /**
-   * Published document ID to create draft from, if draft does not exist
+   * Returns the current client configuration
    */
-  publishedId: string
+  config(): InitializedClientConfig
   /**
-   * Document to create if it does not already exist. Requires `_id` and `_type` properties.
+   * Reconfigure the client. Note that this _mutates_ the current client.
    */
-  attributes: IdentifiedSanityDocumentStub
-}
-
-/** @public */
-export declare const requester: Requester
-
-/** @internal */
-export declare interface RequestObservableOptions extends Omit<RequestOptions, 'url'> {
-  url?: string
-  uri?: string
-  canUseCdn?: boolean
-  useCdn?: boolean
-  tag?: string
-  returnQuery?: boolean
-  resultSourceMap?: boolean | 'withKeyArraySelector'
-  perspective?: ClientPerspective
-  lastLiveEventId?: string
-  cacheMode?: 'noStale'
-}
-
-/** @public */
-export declare interface RequestOptions {
-  timeout?: number
-  token?: string
-  tag?: string
-  headers?: Record<string, string>
-  method?: string
-  query?: Any
-  body?: Any
-  signal?: AbortSignal
-}
-
-export {ResolveStudioUrl}
-
-/** @public */
-export declare interface ResponseEvent<T = unknown> {
-  type: 'response'
-  body: T
-  url: string
-  method: string
-  statusCode: number
-  statusMessage?: string
-  headers: Record<string, string>
-}
-
-/** @public */
-export declare interface ResponseQueryOptions extends RequestOptions {
-  perspective?: ClientPerspective
-  resultSourceMap?: boolean | 'withKeyArraySelector'
-  returnQuery?: boolean
-  useCdn?: boolean
-  stega?: boolean | StegaConfig
-  cache?: 'next' extends keyof RequestInit ? RequestInit['cache'] : never
-  next?: ('next' extends keyof RequestInit ? RequestInit : never)['next']
-  lastLiveEventId?: string | string[] | null
+  config(newConfig?: Partial<ClientConfig>): this
   /**
-   * When set to `noStale`, APICDN will not return a cached response if the content is stale.
-   * Tradeoff between latency and freshness of content.
+   * Get a Sanity API URL for the URI provided
    *
-   * Only to be used with live content queries and when useCdn is true.
+   * @param uri - URI/path to build URL for
+   * @param canUseCdn - Whether or not to allow using the API CDN for this route
    */
-  cacheMode?: 'noStale'
-}
-
-/** @internal */
-export declare interface SanityAssetDocument extends SanityDocument {
-  url: string
-  path: string
-  size: number
-  assetId: string
-  mimeType: string
-  sha1hash: string
-  extension: string
-  uploadId?: string
-  originalFilename?: string
+  getUrl(uri: string, canUseCdn?: boolean): string
+  /**
+   * Get a Sanity API URL for the data operation and path provided
+   *
+   * @param operation - Data operation (eg `query`, `mutate`, `listen` or similar)
+   * @param path - Path to append after the operation
+   */
+  getDataUrl(operation: string, path?: string): string
 }
 
-/** @public */
-export declare class SanityClient {
-  #private
+/**
+ * The interface implemented by the `SanityClient` class.
+ * When writing code that wants to take an instance of `SanityClient` as input it's better to use this type,
+ * as the `SanityClient` class has private properties and thus TypeScrict will consider the type incompatible
+ * in cases where you might have multiple `@sanity/client` instances in your node_modules.
+ * @public
+ */
+export declare interface SanityClientType extends SanityClientBase {
   assets: AssetsClient
   datasets: DatasetsClient
-  live: LiveClient
   projects: ProjectsClient
   users: UsersClient
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
    */
   observable: ObservableSanityClient
-  /**
-   * Instance properties
-   */
-  listen: typeof _listen
-  constructor(httpRequest: HttpRequest, config?: ClientConfig)
   /**
    * Clone the client - returns a new instance
    */
   clone(): SanityClient
-  /**
-   * Returns the current client configuration
-   */
-  config(): InitializedClientConfig
-  /**
-   * Reconfigure the client. Note that this _mutates_ the current client.
-   */
-  config(newConfig?: Partial<ClientConfig>): this
   /**
    * Clone the client with a new (partial) configuration.
    *
@@ -2421,7 +3453,10 @@ export declare class SanityClient {
     R = Any,
     Q extends QueryWithoutParams = QueryWithoutParams,
     const G extends string = string,
-  >(query: G, params?: Q | QueryWithoutParams): Promise<ClientReturn<G, R>>
+  >(
+    query: G,
+    params?: Q | QueryWithoutParams,
+  ): Promise<ClientReturn<G, R>>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -2847,6 +3882,14 @@ export declare class SanityClient {
    * @returns Patch instance - call `.commit()` to perform the operations defined
    */
   patch(selection: MutationSelection, operations?: PatchOperations): Patch
+  /**
+   * Create a new buildable patch of operations to perform
+   *
+   * @param selection - Document ID, an array of document IDs, or an object with `query` and optional `params`, defining which document(s) to patch
+   * @param operations - Optional object of patch operations to initialize the patch instance with
+   * @returns Patch instance - call `.commit()` to perform the operations defined
+   */
+  patch(selection: PatchSelection, operations?: PatchOperations): Patch
   /**
    * Create a new transaction of mutations
    *
@@ -2885,20 +3928,6 @@ export declare class SanityClient {
    * @internal
    */
   dataRequest(endpoint: string, body: unknown, options?: BaseMutationOptions): Promise<Any>
-  /**
-   * Get a Sanity API URL for the URI provided
-   *
-   * @param uri - URI/path to build URL for
-   * @param canUseCdn - Whether or not to allow using the API CDN for this route
-   */
-  getUrl(uri: string, canUseCdn?: boolean): string
-  /**
-   * Get a Sanity API URL for the data operation and path provided
-   *
-   * @param operation - Data operation (eg `query`, `mutate`, `listen` or similar)
-   * @param path - Path to append after the operation
-   */
-  getDataUrl(operation: string, path?: string): string
 }
 
 /** @internal */