@sanity/client 5.0.0-esm.3 → 5.0.0-esm.4

package/src/SanityClient.ts

@@ -2,7 +2,7 @@ import {lastValueFrom, Observable} from 'rxjs'
 
 import {AssetsClient, ObservableAssetsClient} from './assets/AssetsClient'
 import {AuthClient, ObservableAuthClient} from './auth/AuthClient'
-import {initConfig} from './config'
+import {defaultConfig, initConfig} from './config'
 import * as dataMethods from './data/dataMethods'
 import {_listen} from './data/listen'
 import {ObservablePatch, Patch} from './data/patch'
@@ -24,6 +24,7 @@ import type {
   Mutation,
   MutationSelection,
   PatchOperations,
+  PatchSelection,
   QueryParams,
   RawQueryResponse,
   RawRequestOptions,
@@ -48,6 +49,7 @@ export type {
   UsersClient,
 }
 
+/** @public */
 export class ObservableSanityClient {
   assets: ObservableAssetsClient
   auth: ObservableAuthClient
@@ -61,7 +63,7 @@ export class ObservableSanityClient {
   #clientConfig: InitializedClientConfig
   #httpRequest: HttpRequest
 
-  constructor(httpRequest: HttpRequest, config: ClientConfig) {
+  constructor(httpRequest: HttpRequest, config: ClientConfig = defaultConfig) {
     this.config(config)
 
     this.#httpRequest = httpRequest
@@ -106,7 +108,7 @@ export class ObservableSanityClient {
   /**
    * Clone the client with a new (partial) configuration.
    *
-   * @param newConfig New client configuration properties, shallowly merged with existing configuration
+   * @param newConfig - New client configuration properties, shallowly merged with existing configuration
    */
   withConfig(newConfig?: Partial<ClientConfig>): ObservableSanityClient {
     return new ObservableSanityClient(this.#httpRequest, {...this.config(), ...newConfig})
@@ -115,22 +117,22 @@ export class ObservableSanityClient {
   /**
    * Perform a GROQ-query against the configured dataset.
    *
-   * @param query GROQ-query to perform
+   * @param query - GROQ-query to perform
    */
   fetch<R = any>(query: string): Observable<R>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
-   * @param query GROQ-query to perform
-   * @param params Query parameters
+   * @param query - GROQ-query to perform
+   * @param params - Query parameters
    */
   fetch<R = any>(query: string, params: QueryParams): Observable<R>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
-   * @param query GROQ-query to perform
-   * @param params Query parameters
-   * @param options Request options
+   * @param query - GROQ-query to perform
+   * @param params - Query parameters
+   * @param options - Request options
    */
   fetch<R = any>(
     query: string,
@@ -140,9 +142,9 @@ export class ObservableSanityClient {
   /**
    * Perform a GROQ-query against the configured dataset.
    *
-   * @param query GROQ-query to perform
-   * @param params Query parameters
-   * @param options Request options
+   * @param query - GROQ-query to perform
+   * @param params - Query parameters
+   * @param options - Request options
    */
   fetch<R = any>(
     query: string,
@@ -160,8 +162,8 @@ export class ObservableSanityClient {
   /**
    * Fetch a single document with the given ID.
    *
-   * @param id Document ID to fetch
-   * @param options Request options
+   * @param id - Document ID to fetch
+   * @param options - Request options
    */
   getDocument<R extends Record<string, any> = Record<string, any>>(
     id: string,
@@ -176,8 +178,8 @@ export class ObservableSanityClient {
    * The order/position of documents is preserved based on the original array of IDs.
    * If a 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
+   * @param ids - Document IDs to fetch
+   * @param options - Request options
    */
   getDocuments<R extends Record<string, any> = Record<string, any>>(
     ids: string[],
@@ -190,8 +192,8 @@ export class ObservableSanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
@@ -201,8 +203,8 @@ export class ObservableSanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
@@ -212,8 +214,8 @@ export class ObservableSanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
@@ -223,8 +225,8 @@ export class ObservableSanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
@@ -234,8 +236,8 @@ export class ObservableSanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
@@ -259,8 +261,8 @@ export class ObservableSanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -270,8 +272,8 @@ export class ObservableSanityClient {
    * 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 document Document to create
-   * @param options Mutation options
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -281,8 +283,8 @@ export class ObservableSanityClient {
    * 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 document Document to create
-   * @param options Mutation options
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -292,8 +294,8 @@ export class ObservableSanityClient {
    * 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 document Document to create
-   * @param options Mutation options
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -303,8 +305,8 @@ export class ObservableSanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -328,8 +330,8 @@ export class ObservableSanityClient {
    * 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
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
    */
   createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -339,8 +341,8 @@ export class ObservableSanityClient {
    * 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
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
    */
   createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -350,8 +352,8 @@ export class ObservableSanityClient {
    * 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
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
    */
   createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -361,8 +363,8 @@ export class ObservableSanityClient {
    * 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
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
    */
   createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -372,8 +374,8 @@ export class ObservableSanityClient {
    * 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
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
    */
   createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -397,8 +399,8 @@ export class ObservableSanityClient {
    * 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
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
    */
   delete<R extends Record<string, any> = Record<string, any>>(
     id: string,
@@ -408,8 +410,8 @@ export class ObservableSanityClient {
    * 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
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
    */
   delete<R extends Record<string, any> = Record<string, any>>(
     id: string,
@@ -419,24 +421,24 @@ export class ObservableSanityClient {
    * 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
+   * @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
+   * @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
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
    */
   delete<R extends Record<string, any> = Record<string, any>>(
     id: string,
@@ -446,8 +448,8 @@ export class ObservableSanityClient {
    * 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
+   * @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,
@@ -457,8 +459,8 @@ export class ObservableSanityClient {
    * 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
+   * @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,
@@ -468,8 +470,8 @@ export class ObservableSanityClient {
    * 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
+   * @param selection - An object with either an `id` or `query` key defining what to delete
+   * @param options - Options for the mutation
    */
   delete(
     selection: MutationSelection,
@@ -479,8 +481,8 @@ export class ObservableSanityClient {
    * 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
+   * @param selection - An object with either an `id` or `query` key defining what to delete
+   * @param options - Options for the mutation
    */
   delete(
     selection: MutationSelection,
@@ -490,8 +492,8 @@ export class ObservableSanityClient {
    * 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
+   * @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,
@@ -515,8 +517,8 @@ export class ObservableSanityClient {
    * 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
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
    */
   mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | ObservablePatch | ObservableTransaction,
@@ -526,8 +528,8 @@ export class ObservableSanityClient {
    * 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
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
    */
   mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | ObservablePatch | ObservableTransaction,
@@ -537,8 +539,8 @@ export class ObservableSanityClient {
    * 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
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
    */
   mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | ObservablePatch | ObservableTransaction,
@@ -548,8 +550,8 @@ export class ObservableSanityClient {
    * 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
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
    */
   mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | ObservablePatch | ObservableTransaction,
@@ -559,8 +561,8 @@ export class ObservableSanityClient {
    * 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
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
    */
   mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | ObservablePatch | ObservableTransaction,
@@ -583,17 +585,17 @@ export class ObservableSanityClient {
   /**
    * 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
+   * @param documentId - Document ID(s) to patch
+   * @param operations - Optional object of patch operations to initialize the patch instance with
    */
-  patch(documentId: string | MutationSelection, operations?: PatchOperations): ObservablePatch {
+  patch(documentId: PatchSelection, operations?: PatchOperations): ObservablePatch {
     return new ObservablePatch(documentId, operations, this)
   }
 
   /**
    * Create a new transaction of mutations
    *
-   * @param operations Optional array of mutation operations to initialize the transaction instance with
+   * @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>[]
@@ -605,13 +607,14 @@ export class ObservableSanityClient {
    * DEPRECATED: Perform an HTTP request against the Sanity API
    *
    * @deprecated Use your own request library!
-   * @param options Request options
+   * @param options - Request options
    */
   request<R = any>(options: RawRequestOptions): Observable<R> {
     return dataMethods._request(this, this.#httpRequest, options)
   }
 }
 
+/** @public */
 export class SanityClient {
   assets: AssetsClient
   auth: AuthClient
@@ -635,9 +638,7 @@ export class SanityClient {
    */
   listen = _listen
 
-  constructor(httpRequest: HttpRequest, config: ClientConfig) {
-    this.observable = new ObservableSanityClient(httpRequest, config)
-
+  constructor(httpRequest: HttpRequest, config: ClientConfig = defaultConfig) {
     this.config(config)
 
     this.#httpRequest = httpRequest
@@ -647,6 +648,8 @@ export class SanityClient {
     this.datasets = new DatasetsClient(this, this.#httpRequest)
     this.projects = new ProjectsClient(this, this.#httpRequest)
     this.users = new UsersClient(this, this.#httpRequest)
+
+    this.observable = new ObservableSanityClient(httpRequest, config)
   }
 
   /**
@@ -675,7 +678,9 @@ export class SanityClient {
       )
     }
 
-    this.observable.config(newConfig)
+    if (this.observable) {
+      this.observable.config(newConfig)
+    }
 
     this.#clientConfig = initConfig(newConfig, this.#clientConfig || {})
     return this
@@ -684,7 +689,7 @@ export class SanityClient {
   /**
    * Clone the client with a new (partial) configuration.
    *
-   * @param newConfig New client configuration properties, shallowly merged with existing configuration
+   * @param newConfig - New client configuration properties, shallowly merged with existing configuration
    */
   withConfig(newConfig?: Partial<ClientConfig>): SanityClient {
     return new SanityClient(this.#httpRequest, {...this.config(), ...newConfig})
@@ -693,22 +698,22 @@ export class SanityClient {
   /**
    * Perform a GROQ-query against the configured dataset.
    *
-   * @param query GROQ-query to perform
+   * @param query - GROQ-query to perform
    */
   fetch<R = any>(query: string): Promise<R>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
-   * @param query GROQ-query to perform
-   * @param params Optional query parameters
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
    */
   fetch<R = any>(query: string, params: QueryParams): Promise<R>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
-   * @param query GROQ-query to perform
-   * @param params Optional query parameters
-   * @param options Request options
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Request options
    */
   fetch<R = any>(
     query: string,
@@ -718,9 +723,9 @@ export class SanityClient {
   /**
    * Perform a GROQ-query against the configured dataset.
    *
-   * @param query GROQ-query to perform
-   * @param params Optional query parameters
-   * @param options Request options
+   * @param query - GROQ-query to perform
+   * @param params - Optional query parameters
+   * @param options - Request options
    */
   fetch<R = any>(
     query: string,
@@ -738,8 +743,8 @@ export class SanityClient {
   /**
    * Fetch a single document with the given ID.
    *
-   * @param id Document ID to fetch
-   * @param options Request options
+   * @param id - Document ID to fetch
+   * @param options - Request options
    */
   getDocument<R extends Record<string, any> = Record<string, any>>(
     id: string,
@@ -754,8 +759,8 @@ export class SanityClient {
    * The order/position of documents is preserved based on the original array of IDs.
    * If a 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
+   * @param ids - Document IDs to fetch
+   * @param options - Request options
    */
   getDocuments<R extends Record<string, any> = Record<string, any>>(
     ids: string[],
@@ -768,8 +773,8 @@ export class SanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
@@ -779,8 +784,8 @@ export class SanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
@@ -790,8 +795,8 @@ export class SanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
@@ -801,8 +806,8 @@ export class SanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
@@ -812,8 +817,8 @@ export class SanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
@@ -839,8 +844,8 @@ export class SanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -850,8 +855,8 @@ export class SanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -861,8 +866,8 @@ export class SanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -872,8 +877,8 @@ export class SanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -883,8 +888,8 @@ export class SanityClient {
    * 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
+   * @param document - Document to create
+   * @param options - Mutation options
    */
   createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -910,8 +915,8 @@ export class SanityClient {
    * 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
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
    */
   createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -921,8 +926,8 @@ export class SanityClient {
    * 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
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
    */
   createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -932,8 +937,8 @@ export class SanityClient {
    * 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
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
    */
   createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -943,8 +948,8 @@ export class SanityClient {
    * 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
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
    */
   createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -954,8 +959,8 @@ export class SanityClient {
    * 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
+   * @param document - Document to either create or replace
+   * @param options - Mutation options
    */
   createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
@@ -981,8 +986,8 @@ export class SanityClient {
    * 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
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
    */
   delete<R extends Record<string, any> = Record<string, any>>(
     id: string,
@@ -992,8 +997,8 @@ export class SanityClient {
    * 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
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
    */
   delete<R extends Record<string, any> = Record<string, any>>(
     id: string,
@@ -1003,24 +1008,24 @@ export class SanityClient {
    * 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
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
    */
   delete(id: string, options: FirstDocumentIdMutationOptions): Promise<SingleMutationResult>
   /**
    * 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
+   * @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
+   * @param id - Document ID to delete
+   * @param options - Options for the mutation
    */
   delete<R extends Record<string, any> = Record<string, any>>(
     id: string,
@@ -1030,8 +1035,8 @@ export class SanityClient {
    * 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
+   * @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,
@@ -1041,8 +1046,8 @@ export class SanityClient {
    * 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
+   * @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,
@@ -1052,8 +1057,8 @@ export class SanityClient {
    * 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
+   * @param selection - An object with either an `id` or `query` key defining what to delete
+   * @param options - Options for the mutation
    */
   delete(
     selection: MutationSelection,
@@ -1063,8 +1068,8 @@ export class SanityClient {
    * 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
+   * @param selection - An object with either an `id` or `query` key defining what to delete
+   * @param options - Options for the mutation
    */
   delete(
     selection: MutationSelection,
@@ -1074,8 +1079,8 @@ export class SanityClient {
    * 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
+   * @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,
@@ -1099,8 +1104,8 @@ export class SanityClient {
    * 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
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
    */
   mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | Patch | Transaction,
@@ -1110,8 +1115,8 @@ export class SanityClient {
    * 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
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
    */
   mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | Patch | Transaction,
@@ -1121,8 +1126,8 @@ export class SanityClient {
    * 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
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
    */
   mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | Patch | Transaction,
@@ -1132,8 +1137,8 @@ export class SanityClient {
    * 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
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
    */
   mutate<R extends Record<string, any>>(
     operations: Mutation<R>[] | Patch | Transaction,
@@ -1143,8 +1148,8 @@ export class SanityClient {
    * 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
+   * @param operations - Mutation operations to execute
+   * @param options - Mutation options
    */
   mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | Patch | Transaction,
@@ -1167,17 +1172,17 @@ export class SanityClient {
   /**
    * 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
+   * @param documentId - Document ID(s)to patch
+   * @param operations - Optional object of patch operations to initialize the patch instance with
    */
-  patch(documentId: string | MutationSelection, operations?: PatchOperations): Patch {
+  patch(documentId: PatchSelection, operations?: PatchOperations): Patch {
     return new Patch(documentId, operations, this)
   }
 
   /**
    * Create a new transaction of mutations
    *
-   * @param operations Optional array of mutation operations to initialize the transaction instance with
+   * @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>[]
@@ -1189,7 +1194,7 @@ export class SanityClient {
    * DEPRECATED: Perform an HTTP request against the Sanity API
    *
    * @deprecated Use your own request library!
-   * @param options Request options
+   * @param options - Request options
    */
   request<R = any>(options: RawRequestOptions): Promise<R> {
     return lastValueFrom(dataMethods._request<R>(this, this.#httpRequest, options))
@@ -1199,9 +1204,9 @@ export class SanityClient {
    * DEPRECATED: Perform an HTTP request a `/data` sub-endpoint
    *
    * @deprecated Use your own request library!
-   * @param endpoint Endpoint to hit (mutate, query etc)
-   * @param body Request body
-   * @param options Request options
+   * @param endpoint - Endpoint to hit (mutate, query etc)
+   * @param body - Request body
+   * @param options - Request options
    */
   dataRequest(endpoint: string, body: unknown, options?: BaseMutationOptions): Promise<any> {
     return lastValueFrom(dataMethods._dataRequest(this, this.#httpRequest, endpoint, body, options))