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

package/dist/index.d.ts

@@ -4,16 +4,19 @@ import {BaseError} from 'make-error'
 import {Observable} from 'rxjs'
 import {Requester} from 'get-it'
 
+/** @internal */
 export declare type AllDocumentIdsMutationOptions = BaseMutationOptions & {
   returnFirst: false
   returnDocuments: false
 }
 
+/** @internal */
 export declare type AllDocumentsMutationOptions = BaseMutationOptions & {
   returnFirst: false
   returnDocuments?: true
 }
 
+/** @public */
 export declare type AssetMetadataType =
   | 'location'
   | 'exif'
@@ -23,15 +26,16 @@ export declare type AssetMetadataType =
   | 'blurhash'
   | 'none'
 
+/** @internal */
 export declare class AssetsClient {
   #private
   constructor(client: SanityClient, httpRequest: HttpRequest)
   /**
    * Uploads a file asset to the configured dataset
    *
-   * @param assetType Asset type (file/image)
-   * @param body Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
-   * @param options Options to use for the upload
+   * @param assetType - Asset type (file/image)
+   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
+   * @param options - Options to use for the upload
    */
   upload(
     assetType: 'file',
@@ -41,9 +45,9 @@ export declare class AssetsClient {
   /**
    * Uploads an image asset to the configured dataset
    *
-   * @param assetType Asset type (file/image)
-   * @param body Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
-   * @param options Options to use for the upload
+   * @param assetType - Asset type (file/image)
+   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
+   * @param options - Options to use for the upload
    */
   upload(
     assetType: 'image',
@@ -52,10 +56,12 @@ export declare class AssetsClient {
   ): Promise<SanityImageAssetDocument>
 }
 
+/** @internal */
 export declare type AttributeSet = {
   [key: string]: any
 }
 
+/** @internal */
 export declare class AuthClient {
   #private
   constructor(client: SanityClient, httpRequest: HttpRequest)
@@ -69,16 +75,19 @@ export declare class AuthClient {
   logout(): Promise<void>
 }
 
+/** @internal */
 export declare interface AuthProvider {
   name: string
   title: string
   url: string
 }
 
+/** @internal */
 export declare type AuthProviderResponse = {
   providers: AuthProvider[]
 }
 
+/** @internal */
 export declare type BaseMutationOptions = RequestOptions & {
   visibility?: 'sync' | 'async' | 'deferred'
   returnDocuments?: boolean
@@ -88,6 +97,7 @@ export declare type BaseMutationOptions = RequestOptions & {
   skipCrossDatasetReferenceValidation?: boolean
 }
 
+/** @internal */
 export declare class BasePatch {
   protected selection: PatchSelection
   protected operations: PatchOperations
@@ -96,85 +106,85 @@ export declare class BasePatch {
    * DEPRECATED: Don't use.
    * The operation is added to the current patch, ready to be commited by `commit()`
    *
-   * @deprecated
-   * @param attrs Attributes to replace
+   * @deprecated - Don't use.
+   * @param attrs - Attributes to replace
    */
   replace(attrs: AttributeSet): this
   /**
    * Sets the given attributes to the document. Does NOT merge objects.
    * The operation is added to the current patch, ready to be commited by `commit()`
    *
-   * @param attrs Attributes to set. To set a deep attribute, use JSONMatch, eg: {"nested.prop": "value"}
+   * @param attrs - Attributes to set. To set a deep attribute, use JSONMatch, eg: \{"nested.prop": "value"\}
    */
   set(attrs: AttributeSet): this
   /**
    * Sets the given attributes to the document if they are not currently set. Does NOT merge objects.
    * The operation is added to the current patch, ready to be commited by `commit()`
    *
-   * @param attrs Attributes to set. To set a deep attribute, use JSONMatch, eg: {"nested.prop": "value"}
+   * @param attrs - Attributes to set. To set a deep attribute, use JSONMatch, eg: \{"nested.prop": "value"\}
    */
   setIfMissing(attrs: AttributeSet): this
   /**
    * Performs a "diff-match-patch" operation on the string attributes provided.
    * The operation is added to the current patch, ready to be commited by `commit()`
    *
-   * @param attrs Attributes to perform operation on. To set a deep attribute, use JSONMatch, eg: {"nested.prop": "dmp"}
+   * @param attrs - Attributes to perform operation on. To set a deep attribute, use JSONMatch, eg: \{"nested.prop": "dmp"\}
    */
   diffMatchPatch(attrs: AttributeSet): this
   /**
    * Unsets the attribute paths provided.
    * The operation is added to the current patch, ready to be commited by `commit()`
    *
-   * @param attrs Attribute paths to unset.
+   * @param attrs - Attribute paths to unset.
    */
   unset(attrs: string[]): this
   /**
    * Increment a numeric value. Each entry in the argument is either an attribute or a JSON path. The value may be a positive or negative integer or floating-point value. The operation will fail if target value is not a numeric value, or doesn't exist.
    *
-   * @param attrs Object of attribute paths to increment, values representing the number to increment by.
+   * @param attrs - Object of attribute paths to increment, values representing the number to increment by.
    */
   inc(attrs: {[key: string]: number}): this
   /**
    * Decrement a numeric value. Each entry in the argument is either an attribute or a JSON path. The value may be a positive or negative integer or floating-point value. The operation will fail if target value is not a numeric value, or doesn't exist.
    *
-   * @param attrs Object of attribute paths to decrement, values representing the number to decrement by.
+   * @param attrs - Object of attribute paths to decrement, values representing the number to decrement by.
    */
   dec(attrs: {[key: string]: number}): this
   /**
    * Provides methods for modifying arrays, by inserting, appending and replacing elements via a JSONPath expression.
    *
-   * @param at Location to insert at, relative to the given selector, or 'replace' the matched path
-   * @param selector JSONPath expression, eg `comments[-1]` or `blocks[_key=="abc123"]`
-   * @param items Array of items to insert/replace
+   * @param at - Location to insert at, relative to the given selector, or 'replace' the matched path
+   * @param selector - JSONPath expression, eg `comments[-1]` or `blocks[_key=="abc123"]`
+   * @param items - Array of items to insert/replace
    */
   insert(at: 'before' | 'after' | 'replace', selector: string, items: any[]): this
   /**
    * Append the given items to the array at the given JSONPath
    *
-   * @param selector Attribute/path to append to, eg `comments` or `person.hobbies`
-   * @param items Array of items to append to the array
+   * @param selector - Attribute/path to append to, eg `comments` or `person.hobbies`
+   * @param items - Array of items to append to the array
    */
   append(selector: string, items: any[]): this
   /**
    * Prepend the given items to the array at the given JSONPath
    *
-   * @param selector Attribute/path to prepend to, eg `comments` or `person.hobbies`
-   * @param items Array of items to prepend to the array
+   * @param selector - Attribute/path to prepend to, eg `comments` or `person.hobbies`
+   * @param items - Array of items to prepend to the array
    */
   prepend(selector: string, items: any[]): this
   /**
    * Change the contents of an array by removing existing elements and/or adding new elements.
    *
-   * @param selector Attribute or JSONPath expression for array
-   * @param start Index at which to start changing the array (with origin 0). If greater than the length of the array, actual starting index will be set to the length of the array. If negative, will begin that many elements from the end of the array (with origin -1) and will be set to 0 if absolute value is greater than the length of the array.x
-   * @param deleteCount An integer indicating the number of old array elements to remove.
-   * @param items The elements to add to the array, beginning at the start index. If you don't specify any elements, splice() will only remove elements from the array.
+   * @param selector - Attribute or JSONPath expression for array
+   * @param start - Index at which to start changing the array (with origin 0). If greater than the length of the array, actual starting index will be set to the length of the array. If negative, will begin that many elements from the end of the array (with origin -1) and will be set to 0 if absolute value is greater than the length of the array.x
+   * @param deleteCount - An integer indicating the number of old array elements to remove.
+   * @param items - The elements to add to the array, beginning at the start index. If you don't specify any elements, splice() will only remove elements from the array.
    */
-  splice(selector: string, start: number, deleteCount: number, items: any[]): this
+  splice(selector: string, start: number, deleteCount?: number, items?: any[]): this
   /**
    * Adds a revision clause, preventing the document from being patched if the `_rev` property does not match the given value
    *
-   * @param rev Revision to lock the patch to
+   * @param rev - Revision to lock the patch to
    */
   ifRevisionId(rev: string): this
   /**
@@ -193,6 +203,7 @@ export declare class BasePatch {
   protected _set(op: keyof PatchOperations, props: any): this
 }
 
+/** @internal */
 export declare class BaseTransaction {
   protected operations: Mutation[]
   protected trxId?: string
@@ -254,11 +265,13 @@ export declare class BaseTransaction {
   protected _add(mut: Mutation): this
 }
 
+/** @public */
 export declare type ChannelErrorEvent = {
   type: 'channelError'
   message: string
 }
 
+/** @public */
 export declare interface ClientConfig {
   projectId?: string
   dataset?: string
@@ -282,6 +295,7 @@ export declare interface ClientConfig {
   requester?: Requester
 }
 
+/** @public */
 export declare class ClientError extends BaseError {
   response: ErrorProps['response']
   statusCode: ErrorProps['statusCode']
@@ -290,8 +304,10 @@ export declare class ClientError extends BaseError {
   constructor(res: any)
 }
 
-export declare function createClient(config: ClientConfig): SanityClient
+/** @public */
+export declare const createClient: (config: ClientConfig) => SanityClient
 
+/** @internal */
 export declare interface CurrentSanityUser {
   id: string
   name: string
@@ -300,13 +316,16 @@ export declare interface CurrentSanityUser {
   role: string
 }
 
+/** @internal */
 export declare type DatasetAclMode = 'public' | 'private' | 'custom'
 
+/** @internal */
 export declare type DatasetResponse = {
   datasetName: string
   aclMode: DatasetAclMode
 }
 
+/** @internal */
 export declare class DatasetsClient {
   #private
   constructor(client: SanityClient, httpRequest: HttpRequest)
@@ -348,16 +367,19 @@ export declare class DatasetsClient {
   list(): Promise<DatasetsResponse>
 }
 
+/** @internal */
 export declare type DatasetsResponse = {
   name: string
   aclMode: DatasetAclMode
 }[]
 
+/** @public */
 export declare type DisconnectEvent = {
   type: 'disconnect'
   reason: string
 }
 
+/** @public */
 export declare interface ErrorProps {
   message: string
   response: any
@@ -366,27 +388,33 @@ export declare interface ErrorProps {
   details: any
 }
 
+/** @internal */
 export declare type FilteredResponseQueryOptions = RequestOptions & {
   filterResponse?: true
 }
 
+/** @internal */
 export declare type FirstDocumentIdMutationOptions = BaseMutationOptions & {
   returnFirst?: true
   returnDocuments: false
 }
 
+/** @internal */
 export declare type FirstDocumentMutationOptions = BaseMutationOptions & {
   returnFirst?: true
   returnDocuments?: true
 }
 
+/** @public */
 export declare type HttpRequest = {
   defaultRequester: Requester
   (options: RequestOptions, requester: Requester): ReturnType<Requester>
 }
 
+/** @public */
 export declare type HttpRequestEvent<T = unknown> = ResponseEvent<T> | ProgressEvent_2
 
+/** @public */
 export declare type IdentifiedSanityDocumentStub<
   T extends Record<string, any> = Record<string, any>
 > = {
@@ -395,6 +423,7 @@ export declare type IdentifiedSanityDocumentStub<
   _id: string
 } & SanityDocumentStub
 
+/** @public */
 export declare interface InitializedClientConfig extends ClientConfig {
   apiHost: string
   apiVersion: string
@@ -414,6 +443,7 @@ export declare interface InitializedClientConfig extends ClientConfig {
   cdnUrl: string
 }
 
+/** @internal */
 export declare type InsertPatch =
   | {
       before: string
@@ -431,9 +461,9 @@ export declare type InsertPatch =
 /**
  * Set up a listener that will be notified when mutations occur on documents matching the provided query/filter.
  *
- * @param query GROQ-filter to listen to changes for
- * @param params Optional query parameters
- * @param options Listener options
+ * @param query - GROQ-filter to listen to changes for
+ * @param params - Optional query parameters
+ * @param options - Listener options
  * @internal
  */
 export declare function _listen<R extends Record<string, any> = Record<string, any>>(
@@ -445,9 +475,9 @@ export declare function _listen<R extends Record<string, any> = Record<string, a
 /**
  * Set up a listener that will be notified when mutations occur on documents matching the provided query/filter.
  *
- * @param query GROQ-filter to listen to changes for
- * @param params Optional query parameters
- * @param options Listener options
+ * @param query - GROQ-filter to listen to changes for
+ * @param params - Optional query parameters
+ * @param options - Listener options
  * @internal
  */
 export declare function _listen<R extends Record<string, any> = Record<string, any>>(
@@ -457,6 +487,7 @@ export declare function _listen<R extends Record<string, any> = Record<string, a
   options?: ListenOptions
 ): Observable<ListenEvent<R>>
 
+/** @public */
 export declare type ListenEvent<R extends Record<string, any>> =
   | MutationEvent_2<R>
   | ChannelErrorEvent
@@ -464,8 +495,10 @@ export declare type ListenEvent<R extends Record<string, any>> =
   | ReconnectEvent
   | WelcomeEvent
 
+/** @public */
 export declare type ListenEventName = 'mutation' | 'welcome' | 'reconnect'
 
+/** @public */
 export declare interface ListenOptions {
   includeResult?: boolean
   includePreviousRevision?: boolean
@@ -475,6 +508,7 @@ export declare interface ListenOptions {
   tag?: string
 }
 
+/** @internal */
 export declare interface MultipleMutationResult {
   transactionId: string
   documentIds: string[]
@@ -484,6 +518,7 @@ export declare interface MultipleMutationResult {
   }[]
 }
 
+/** @public */
 export declare type Mutation<R extends Record<string, any> = Record<string, any>> =
   | {
       create: SanityDocumentStub<R>
@@ -501,6 +536,7 @@ export declare type Mutation<R extends Record<string, any> = Record<string, any>
       patch: PatchMutationOperation
     }
 
+/** @public */
 declare type MutationEvent_2<R extends Record<string, any> = Record<string, any>> = {
   type: 'mutation'
   documentId: string
@@ -522,8 +558,10 @@ declare type MutationEvent_2<R extends Record<string, any> = Record<string, any>
 }
 export {MutationEvent_2 as MutationEvent}
 
+/** @internal */
 export declare type MutationOperation = 'create' | 'delete' | 'update' | 'none'
 
+/** @internal */
 export declare type MutationSelection =
   | {
       query: string
@@ -533,15 +571,16 @@ export declare type MutationSelection =
       id: string | string[]
     }
 
+/** @internal */
 export declare class ObservableAssetsClient {
   #private
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
   /**
    * Uploads a file asset to the configured dataset
    *
-   * @param assetType Asset type (file/image)
-   * @param body Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
-   * @param options Options to use for the upload
+   * @param assetType - Asset type (file/image)
+   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
+   * @param options - Options to use for the upload
    */
   upload(
     assetType: 'file',
@@ -555,9 +594,9 @@ export declare class ObservableAssetsClient {
   /**
    * Uploads an image asset to the configured dataset
    *
-   * @param assetType Asset type (file/image)
-   * @param body Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
-   * @param options Options to use for the upload
+   * @param assetType - Asset type (file/image)
+   * @param body - Asset content - can be a browser File instance, a Blob, a Node.js Buffer instance or a Node.js ReadableStream.
+   * @param options - Options to use for the upload
    */
   upload(
     assetType: 'image',
@@ -570,6 +609,7 @@ export declare class ObservableAssetsClient {
   >
 }
 
+/** @internal */
 export declare class ObservableAuthClient {
   #private
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
@@ -583,6 +623,7 @@ export declare class ObservableAuthClient {
   logout(): Observable<void>
 }
 
+/** @internal */
 export declare class ObservableDatasetsClient {
   #private
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
@@ -624,6 +665,7 @@ export declare class ObservableDatasetsClient {
   list(): Observable<DatasetsResponse>
 }
 
+/** @public */
 export declare class ObservablePatch extends BasePatch {
   #private
   constructor(
@@ -638,7 +680,7 @@ export declare class ObservablePatch extends BasePatch {
   /**
    * Commit the patch, returning an observable that produces the first patched document
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit<R extends Record<string, any> = Record<string, any>>(
     options: FirstDocumentMutationOptions
@@ -646,7 +688,7 @@ export declare class ObservablePatch extends BasePatch {
   /**
    * Commit the patch, returning an observable that produces an array of the mutated documents
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit<R extends Record<string, any> = Record<string, any>>(
     options: AllDocumentsMutationOptions
@@ -654,27 +696,29 @@ export declare class ObservablePatch extends BasePatch {
   /**
    * Commit the patch, returning an observable that produces a mutation result object
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit(options: FirstDocumentIdMutationOptions): Observable<SingleMutationResult>
   /**
    * Commit the patch, returning an observable that produces a mutation result object
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit(options: AllDocumentIdsMutationOptions): Observable<MultipleMutationResult>
   /**
    * Commit the patch, returning an observable that produces the first patched document
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit<R extends Record<string, any> = Record<string, any>>(
     options?: BaseMutationOptions
   ): Observable<SanityDocument<R>>
 }
 
+/** @public */
 export declare type ObservablePatchBuilder = (patch: ObservablePatch) => ObservablePatch
 
+/** @internal */
 export declare class ObservableProjectsClient {
   #private
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
@@ -690,6 +734,7 @@ export declare class ObservableProjectsClient {
   getById(projectId: string): Observable<SanityProject>
 }
 
+/** @public */
 export declare class ObservableSanityClient {
   #private
   assets: ObservableAssetsClient
@@ -697,7 +742,7 @@ export declare class ObservableSanityClient {
   datasets: ObservableDatasetsClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
-  constructor(httpRequest: HttpRequest, config: ClientConfig)
+  constructor(httpRequest: HttpRequest, config?: ClientConfig)
   /**
    * Clone the client - returns a new instance
    */
@@ -713,28 +758,28 @@ export declare 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
   /**
    * 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,
@@ -744,9 +789,9 @@ export declare 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,
@@ -756,8 +801,8 @@ export declare 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,
@@ -771,8 +816,8 @@ export declare 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[],
@@ -784,8 +829,8 @@ export declare 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>,
@@ -795,8 +840,8 @@ export declare 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>,
@@ -806,8 +851,8 @@ export declare 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>,
@@ -817,8 +862,8 @@ export declare 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>,
@@ -828,8 +873,8 @@ export declare 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>,
@@ -839,8 +884,8 @@ export declare 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>,
@@ -850,8 +895,8 @@ export declare 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>,
@@ -861,8 +906,8 @@ export declare 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>,
@@ -872,8 +917,8 @@ export declare 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>,
@@ -883,8 +928,8 @@ export declare 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>,
@@ -894,8 +939,8 @@ export declare 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>,
@@ -905,8 +950,8 @@ export declare 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>,
@@ -916,8 +961,8 @@ export declare 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>,
@@ -927,8 +972,8 @@ export declare 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>,
@@ -938,8 +983,8 @@ export declare 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>,
@@ -949,8 +994,8 @@ export declare 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,
@@ -960,8 +1005,8 @@ export declare 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,
@@ -971,24 +1016,24 @@ export declare 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,
@@ -998,8 +1043,8 @@ export declare 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,
@@ -1009,8 +1054,8 @@ export declare 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,
@@ -1020,8 +1065,8 @@ export declare 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,
@@ -1031,8 +1076,8 @@ export declare 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,
@@ -1042,8 +1087,8 @@ export declare 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,
@@ -1053,8 +1098,8 @@ export declare 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,
@@ -1064,8 +1109,8 @@ export declare 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,
@@ -1075,8 +1120,8 @@ export declare 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,
@@ -1086,8 +1131,8 @@ export declare 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,
@@ -1097,8 +1142,8 @@ export declare 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,
@@ -1107,14 +1152,14 @@ export declare 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
   /**
    * 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>[]
@@ -1123,11 +1168,12 @@ export declare 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>
 }
 
+/** @public */
 export declare class ObservableTransaction extends BaseTransaction {
   #private
   constructor(operations?: Mutation[], client?: ObservableSanityClient, transactionId?: string)
@@ -1186,6 +1232,7 @@ export declare class ObservableTransaction extends BaseTransaction {
   patch(patch: ObservablePatch): this
 }
 
+/** @public */
 export declare class ObservableUsersClient {
   #private
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
@@ -1199,6 +1246,7 @@ export declare class ObservableUsersClient {
   ): Observable<T extends 'me' ? CurrentSanityUser : SanityUser>
 }
 
+/** @public */
 export declare class Patch extends BasePatch {
   #private
   constructor(selection: PatchSelection, operations?: PatchOperations, client?: SanityClient)
@@ -1209,7 +1257,7 @@ export declare class Patch extends BasePatch {
   /**
    * Commit the patch, returning a promise that resolves to the first patched document
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit<R extends Record<string, any> = Record<string, any>>(
     options: FirstDocumentMutationOptions
@@ -1217,7 +1265,7 @@ export declare class Patch extends BasePatch {
   /**
    * Commit the patch, returning a promise that resolves to an array of the mutated documents
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit<R extends Record<string, any> = Record<string, any>>(
     options: AllDocumentsMutationOptions
@@ -1225,29 +1273,32 @@ export declare class Patch extends BasePatch {
   /**
    * Commit the patch, returning a promise that resolves to a mutation result object
    *
-   * @param options Options for the mutation operation
+   * @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
+   * @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
+   * @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 */
 export declare interface PatchOperations {
   set?: {
     [key: string]: any
@@ -1269,8 +1320,10 @@ export declare interface PatchOperations {
   ifRevisionID?: string
 }
 
+/** @internal */
 export declare type PatchSelection = string | string[] | MutationSelection
 
+/** @public */
 declare interface ProgressEvent_2 {
   type: 'progress'
   stage: 'upload' | 'download'
@@ -1281,6 +1334,7 @@ declare interface ProgressEvent_2 {
 }
 export {ProgressEvent_2 as ProgressEvent}
 
+/** @internal */
 export declare class ProjectsClient {
   #private
   constructor(client: SanityClient, httpRequest: HttpRequest)
@@ -1296,16 +1350,19 @@ export declare class ProjectsClient {
   getById(projectId: string): Promise<SanityProject>
 }
 
+/** @public */
 export declare type QueryParams = {
   [key: string]: any
 }
 
+/** @internal */
 export declare interface RawQueryResponse<R> {
   q: string
   ms: number
   result: R
 }
 
+/** @internal */
 export declare interface RawRequestOptions {
   url?: string
   uri?: string
@@ -1327,12 +1384,15 @@ export declare interface RawRequestOptions {
   maxRedirects?: number
 }
 
+/** @public */
 export declare type ReconnectEvent = {
   type: 'reconnect'
 }
 
+/** @public */
 export declare const requester: Requester
 
+/** @internal */
 export declare interface RequestObservableOptions extends Omit<RequestOptions, 'url'> {
   url?: string
   uri?: string
@@ -1340,6 +1400,7 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   tag?: string
 }
 
+/** @public */
 export declare interface RequestOptions {
   timeout?: number
   token?: string
@@ -1350,6 +1411,7 @@ export declare interface RequestOptions {
   body?: any
 }
 
+/** @public */
 export declare interface ResponseEvent<T = unknown> {
   type: 'response'
   body: T
@@ -1360,6 +1422,7 @@ export declare interface ResponseEvent<T = unknown> {
   headers: Record<string, string>
 }
 
+/** @internal */
 export declare interface SanityAssetDocument extends SanityDocument {
   url: string
   path: string
@@ -1372,6 +1435,7 @@ export declare interface SanityAssetDocument extends SanityDocument {
   originalFilename?: string
 }
 
+/** @public */
 export declare class SanityClient {
   #private
   assets: AssetsClient
@@ -1387,7 +1451,7 @@ export declare class SanityClient {
    * Instance properties
    */
   listen: typeof _listen
-  constructor(httpRequest: HttpRequest, config: ClientConfig)
+  constructor(httpRequest: HttpRequest, config?: ClientConfig)
   /**
    * Clone the client - returns a new instance
    */
@@ -1403,28 +1467,28 @@ export declare 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
   /**
    * 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,
@@ -1434,9 +1498,9 @@ export declare 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,
@@ -1446,8 +1510,8 @@ export declare 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,
@@ -1461,8 +1525,8 @@ export declare 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[],
@@ -1474,8 +1538,8 @@ export declare 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>,
@@ -1485,8 +1549,8 @@ export declare 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>,
@@ -1496,8 +1560,8 @@ export declare 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>,
@@ -1507,8 +1571,8 @@ export declare 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>,
@@ -1518,8 +1582,8 @@ export declare 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>,
@@ -1529,8 +1593,8 @@ export declare 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>,
@@ -1540,8 +1604,8 @@ export declare 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>,
@@ -1551,8 +1615,8 @@ export declare 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>,
@@ -1562,8 +1626,8 @@ export declare 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>,
@@ -1573,8 +1637,8 @@ export declare 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>,
@@ -1584,8 +1648,8 @@ export declare 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>,
@@ -1595,8 +1659,8 @@ export declare 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>,
@@ -1606,8 +1670,8 @@ export declare 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>,
@@ -1617,8 +1681,8 @@ export declare 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>,
@@ -1628,8 +1692,8 @@ export declare 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>,
@@ -1639,8 +1703,8 @@ export declare 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,
@@ -1650,8 +1714,8 @@ export declare 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,
@@ -1661,24 +1725,24 @@ export declare 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,
@@ -1688,8 +1752,8 @@ export declare 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,
@@ -1699,8 +1763,8 @@ export declare 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,
@@ -1710,8 +1774,8 @@ export declare 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,
@@ -1721,8 +1785,8 @@ export declare 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,
@@ -1732,8 +1796,8 @@ export declare 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,
@@ -1743,8 +1807,8 @@ export declare 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,
@@ -1754,8 +1818,8 @@ export declare 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,
@@ -1765,8 +1829,8 @@ export declare 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,
@@ -1776,8 +1840,8 @@ export declare 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,
@@ -1787,8 +1851,8 @@ export declare 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,
@@ -1797,14 +1861,14 @@ export declare 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
   /**
    * 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>[]
@@ -1813,20 +1877,21 @@ export declare 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>
   /**
    * 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>
 }
 
+/** @internal */
 export declare type SanityDocument<T extends Record<string, any> = Record<string, any>> = {
   [P in keyof T]: T[P]
 } & {
@@ -1837,12 +1902,14 @@ export declare type SanityDocument<T extends Record<string, any> = Record<string
   _updatedAt: string
 }
 
+/** @public */
 export declare type SanityDocumentStub<T extends Record<string, any> = Record<string, any>> = {
   [P in keyof T]: T[P]
 } & {
   _type: string
 }
 
+/** @internal */
 export declare interface SanityImageAssetDocument extends SanityAssetDocument {
   metadata: {
     _type: 'sanity.imageMetadata'
@@ -1877,6 +1944,7 @@ export declare interface SanityImageAssetDocument extends SanityAssetDocument {
   }
 }
 
+/** @internal */
 export declare interface SanityImagePalette {
   background: string
   foreground: string
@@ -1884,6 +1952,7 @@ export declare interface SanityImagePalette {
   title: string
 }
 
+/** @internal */
 export declare interface SanityProject {
   id: string
   displayName: string
@@ -1902,6 +1971,7 @@ export declare interface SanityProject {
   }
 }
 
+/** @internal */
 export declare interface SanityProjectMember {
   id: string
   role: string
@@ -1909,10 +1979,12 @@ export declare interface SanityProjectMember {
   isCurrentUser: boolean
 }
 
+/** @internal */
 export declare interface SanityReference {
   _ref: string
 }
 
+/** @internal */
 export declare interface SanityUser {
   id: string
   projectId: string
@@ -1926,6 +1998,7 @@ export declare interface SanityUser {
   isCurrentUser: boolean
 }
 
+/** @public */
 export declare class ServerError extends BaseError {
   response: ErrorProps['response']
   statusCode: ErrorProps['statusCode']
@@ -1934,6 +2007,7 @@ export declare class ServerError extends BaseError {
   constructor(res: any)
 }
 
+/** @internal */
 export declare interface SingleMutationResult {
   transactionId: string
   documentId: string
@@ -1943,6 +2017,7 @@ export declare interface SingleMutationResult {
   }[]
 }
 
+/** @public */
 export declare class Transaction extends BaseTransaction {
   #private
   constructor(operations?: Mutation[], client?: SanityClient, transactionId?: string)
@@ -2001,36 +2076,43 @@ export declare class Transaction extends BaseTransaction {
   patch(patch: Patch): this
 }
 
+/** @internal */
 export declare type TransactionAllDocumentIdsMutationOptions = BaseMutationOptions & {
   returnFirst?: false
   returnDocuments?: false
 }
 
+/** @internal */
 export declare type TransactionAllDocumentsMutationOptions = BaseMutationOptions & {
   returnFirst?: false
   returnDocuments: true
 }
 
+/** @internal */
 export declare type TransactionFirstDocumentIdMutationOptions = BaseMutationOptions & {
   returnFirst: true
   returnDocuments?: false
 }
 
+/** @internal */
 export declare type TransactionFirstDocumentMutationOptions = BaseMutationOptions & {
   returnFirst: true
   returnDocuments: true
 }
 
+/** @internal */
 export declare type TransactionMutationOptions =
   | TransactionFirstDocumentMutationOptions
   | TransactionFirstDocumentIdMutationOptions
   | TransactionAllDocumentsMutationOptions
   | TransactionAllDocumentIdsMutationOptions
 
+/** @internal */
 export declare type UnfilteredResponseQueryOptions = RequestOptions & {
   filterResponse: false
 }
 
+/** @public */
 export declare interface UploadClientConfig {
   /**
    * Optional request tag for the upload
@@ -2091,6 +2173,7 @@ export declare interface UploadClientConfig {
   }
 }
 
+/** @public */
 export declare class UsersClient {
   #private
   constructor(client: SanityClient, httpRequest: HttpRequest)
@@ -2102,6 +2185,7 @@ export declare class UsersClient {
   getById<T extends 'me' | string>(id: T): Promise<T extends 'me' ? CurrentSanityUser : SanityUser>
 }
 
+/** @public */
 export declare type WelcomeEvent = {
   type: 'welcome'
 }