@sanity/client 4.0.0-alpha.esm.6 → 4.0.0

package/sanityClient.d.ts

@@ -12,6 +12,7 @@ export type AssetMetadataType =
 export type DatasetAclMode = 'public' | 'private' | 'custom'
 export type ListenVisibility = 'sync' | 'async' | 'query'
 export type ListenEventName = 'mutation' | 'welcome' | 'reconnect'
+export type MutationOperation = 'create' | 'delete' | 'update' | 'none'
 
 export interface ResponseEvent<T = unknown> {
   type: 'response'
@@ -34,7 +35,7 @@ export interface ProgressEvent {
 
 type AttributeSet = {[key: string]: any}
 type QueryParams = {[key: string]: any}
-type MutationSelection = {query: string} | {id: string}
+type MutationSelection = {query: string; params?: QueryParams} | {id: string}
 type SanityReference = {_ref: string}
 
 interface RawRequestOptions {
@@ -204,7 +205,7 @@ export type PatchBuilder = (patch: Patch) => Patch
 
 export type PatchMutationOperation = PatchOperations & MutationSelection
 
-export type Mutation<R = any> =
+export type Mutation<R extends Record<string, any> = Record<string, any>> =
   | {create: SanityDocumentStub<R>}
   | {createOrReplace: IdentifiedSanityDocumentStub<R>}
   | {createIfNotExists: IdentifiedSanityDocumentStub<R>}
@@ -214,23 +215,16 @@ export type Mutation<R = any> =
 export interface SingleMutationResult {
   transactionId: string
   documentId: string
-  results: {id: string}[]
+  results: {id: string; operation: MutationOperation}[]
 }
 
 export interface MultipleMutationResult {
   transactionId: string
   documentIds: string[]
-  results: {id: string}[]
+  results: {id: string; operation: MutationOperation}[]
 }
 
-export class Patch {
-  constructor(documentId: string, operations?: PatchOperations, client?: SanityClient)
-
-  /**
-   * Clones the patch
-   */
-  clone(): Patch
-
+export abstract class BasePatch {
   /**
    * DEPRECATED: Don't use.
    * The operation is added to the current patch, ready to be commited by `commit()`
@@ -338,19 +332,37 @@ export class Patch {
    */
   toJSON(): PatchMutationOperation
 
+  /**
+   * Clears the patch of all operations
+   */
+  reset(): this
+}
+
+export class Patch extends BasePatch {
+  constructor(documentId: string, operations?: PatchOperations, client?: SanityClient)
+
+  /**
+   * Clones the patch
+   */
+  clone(): Patch
+
   /**
    * Commit the patch, returning a promise that resolves to the first patched document
    *
    * @param options Options for the mutation operation
    */
-  commit<R = any>(options: FirstDocumentMutationOptions): Promise<SanityDocument<R>>
+  commit<R extends Record<string, any> = Record<string, any>>(
+    options: FirstDocumentMutationOptions
+  ): Promise<SanityDocument<R>>
 
   /**
    * Commit the patch, returning a promise that resolves to an array of the mutated documents
    *
    * @param options Options for the mutation operation
    */
-  commit<R = any>(options: AllDocumentsMutationOptions): Promise<SanityDocument<R>[]>
+  commit<R extends Record<string, any> = Record<string, any>>(
+    options: AllDocumentsMutationOptions
+  ): Promise<SanityDocument<R>[]>
 
   /**
    * Commit the patch, returning a promise that resolves to a mutation result object
@@ -371,25 +383,69 @@ export class Patch {
    *
    * @param options Options for the mutation operation
    */
-  commit<R = any>(options?: BaseMutationOptions): Promise<SanityDocument<R>>
+  commit<R extends Record<string, any> = Record<string, any>>(
+    options?: BaseMutationOptions
+  ): Promise<SanityDocument<R>>
+}
+
+export class ObservablePatch extends BasePatch {
+  constructor(documentId: string, operations?: PatchOperations, client?: ObservableSanityClient)
 
   /**
-   * Clears the patch of all operations
+   * Clones the patch
    */
-  reset(): this
-}
+  clone(): ObservablePatch
 
-export class Transaction {
-  constructor(operations?: Mutation[], client?: SanityClient, transactionId?: string)
-  clone(): Transaction
+  /**
+   * Commit the patch, returning an observable that produces the first patched document
+   *
+   * @param options Options for the mutation operation
+   */
+  commit<R extends Record<string, any> = Record<string, any>>(
+    options: FirstDocumentMutationOptions
+  ): Observable<SanityDocument<R>>
+
+  /**
+   * Commit the patch, returning an observable that produces an array of the mutated documents
+   *
+   * @param options Options for the mutation operation
+   */
+  commit<R extends Record<string, any> = Record<string, any>>(
+    options: AllDocumentsMutationOptions
+  ): Observable<SanityDocument<R>[]>
 
+  /**
+   * Commit the patch, returning an observable that produces a mutation result object
+   *
+   * @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
+   */
+  commit(options: AllDocumentIdsMutationOptions): Observable<MultipleMutationResult>
+
+  /**
+   * Commit the patch, returning an observable that produces the first patched document
+   *
+   * @param options Options for the mutation operation
+   */
+  commit<R extends Record<string, any> = Record<string, any>>(
+    options?: BaseMutationOptions
+  ): Observable<SanityDocument<R>>
+}
+
+export abstract class BaseTransaction {
   /**
    * Creates a new Sanity document. If `_id` is provided and already exists, the mutation will fail. If no `_id` is given, one will automatically be generated by the database.
    * The operation is added to the current transaction, ready to be commited by `commit()`
    *
    * @param doc Document to create. Requires a `_type` property.
    */
-  create<R = any>(doc: SanityDocumentStub<R>): this
+  create<R extends Record<string, any> = Record<string, any>>(doc: SanityDocumentStub<R>): this
 
   /**
    * Creates a new Sanity document. If a document with the same `_id` already exists, the create operation will be ignored.
@@ -397,7 +453,9 @@ export class Transaction {
    *
    * @param doc Document to create if it does not already exist. Requires `_id` and `_type` properties.
    */
-  createIfNotExists<R = any>(doc: IdentifiedSanityDocumentStub<R>): this
+  createIfNotExists<R extends Record<string, any> = Record<string, any>>(
+    doc: IdentifiedSanityDocumentStub<R>
+  ): this
 
   /**
    * Creates a new Sanity document, or replaces an existing one if the same `_id` is already used.
@@ -405,7 +463,9 @@ export class Transaction {
    *
    * @param doc Document to create or replace. Requires `_id` and `_type` properties.
    */
-  createOrReplace<R = any>(doc: IdentifiedSanityDocumentStub<R>): this
+  createOrReplace<R extends Record<string, any> = Record<string, any>>(
+    doc: IdentifiedSanityDocumentStub<R>
+  ): this
 
   /**
    * Deletes the document with the given document ID
@@ -451,19 +511,37 @@ export class Transaction {
    */
   toJSON(): Mutation[]
 
+  /**
+   * Clears the transaction of all operations
+   */
+  reset(): this
+}
+
+export class Transaction extends BaseTransaction {
+  constructor(operations?: Mutation[], client?: SanityClient, transactionId?: string)
+
+  /**
+   * Clones the transaction
+   */
+  clone(): Transaction
+
   /**
    * Commit the transaction, returning a promise that resolves to the first mutated document
    *
    * @param options Options for the mutation operation
    */
-  commit<R>(options: TransactionFirstDocumentMutationOptions): Promise<SanityDocument<R>>
+  commit<R extends Record<string, any>>(
+    options: TransactionFirstDocumentMutationOptions
+  ): Promise<SanityDocument<R>>
 
   /**
    * Commit the transaction, returning a promise that resolves to an array of the mutated documents
    *
    * @param options Options for the mutation operation
    */
-  commit<R>(options: TransactionAllDocumentsMutationOptions): Promise<SanityDocument<R>[]>
+  commit<R extends Record<string, any>>(
+    options: TransactionAllDocumentsMutationOptions
+  ): Promise<SanityDocument<R>[]>
 
   /**
    * Commit the transaction, returning a promise that resolves to a mutation result object
@@ -485,11 +563,54 @@ export class Transaction {
    * @param options Options for the mutation operation
    */
   commit(options?: BaseMutationOptions): Promise<MultipleMutationResult>
+}
+
+export class ObservableTransaction extends BaseTransaction {
+  constructor(operations?: Mutation[], client?: ObservableSanityClient, transactionId?: string)
 
   /**
-   * Clears the transaction of all operations
+   * Clones the transaction
    */
-  reset(): this
+  clone(): ObservableTransaction
+
+  /**
+   * Commit the transaction, returning an observable that produces the first mutated document
+   *
+   * @param options Options for the mutation operation
+   */
+  commit<R extends Record<string, any>>(
+    options: TransactionFirstDocumentMutationOptions
+  ): Observable<SanityDocument<R>>
+
+  /**
+   * Commit the transaction, returning an observable that produces an array of the mutated documents
+   *
+   * @param options Options for the mutation operation
+   */
+  commit<R extends Record<string, any>>(
+    options: TransactionAllDocumentsMutationOptions
+  ): Observable<SanityDocument<R>[]>
+
+  /**
+   * Commit the transaction, returning an observable that produces a mutation result object
+   *
+   * @param options Options for the mutation operation
+   */
+  commit(options: TransactionFirstDocumentIdMutationOptions): Observable<SingleMutationResult>
+
+  /**
+   * Commit the transaction, returning an observable that produces a mutation result object
+   *
+   * @param options Options for the mutation operation
+   */
+  commit(options: TransactionAllDocumentIdsMutationOptions): Observable<MultipleMutationResult>
+
+  /**
+   * Commit the transaction, returning an observable that produces a mutation result object
+   *
+   * @param options Options for the mutation operation
+   */
+  commit(options?: BaseMutationOptions): Observable<MultipleMutationResult>
 }
 
 export interface ClientConfig {
@@ -503,6 +624,7 @@ export interface ClientConfig {
   requestTagPrefix?: string
   ignoreBrowserTokenWarning?: boolean
   withCredentials?: boolean
+  allowReconfigure?: boolean
   timeout?: number
 
   /**
@@ -545,7 +667,7 @@ type BaseMutationOptions = RequestOptions & {
   skipCrossDatasetReferenceValidation?: boolean
 }
 
-export type MutationEvent<R = any> = {
+export type MutationEvent<R extends Record<string, any> = Record<string, any>> = {
   type: 'mutation'
   documentId: string
   eventId: string
@@ -580,7 +702,7 @@ export type WelcomeEvent = {
   type: 'welcome'
 }
 
-export type ListenEvent<R> =
+export type ListenEvent<R extends Record<string, any>> =
   | MutationEvent<R>
   | ChannelErrorEvent
   | DisconnectEvent
@@ -1014,7 +1136,7 @@ export class ObservableSanityClient {
    * @param id Document ID to fetch
    * @param options Request options
    */
-  getDocument<R = any>(
+  getDocument<R extends Record<string, any> = Record<string, any>>(
     id: string,
     options?: {tag?: string}
   ): Observable<SanityDocument<R> | undefined>
@@ -1028,7 +1150,7 @@ export class ObservableSanityClient {
    * @param ids Document IDs to fetch
    * @param options Request options
    */
-  getDocuments<R = any>(
+  getDocuments<R extends Record<string, any> = Record<string, any>>(
     ids: string[],
     options?: {tag?: string}
   ): Observable<(SanityDocument<R> | null)[]>
@@ -1040,7 +1162,7 @@ export class ObservableSanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  create<R = any>(
+  create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
     options: FirstDocumentMutationOptions
   ): Observable<SanityDocument<R>>
@@ -1052,7 +1174,7 @@ export class ObservableSanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  create<R = any>(
+  create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
     options: AllDocumentsMutationOptions
   ): Observable<SanityDocument<R>[]>
@@ -1064,7 +1186,7 @@ export class ObservableSanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  create<R = any>(
+  create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
     options: FirstDocumentIdMutationOptions
   ): Observable<SingleMutationResult>
@@ -1076,7 +1198,7 @@ export class ObservableSanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  create<R = any>(
+  create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
     options: AllDocumentIdsMutationOptions
   ): Observable<MultipleMutationResult>
@@ -1088,7 +1210,7 @@ export class ObservableSanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  create<R = any>(
+  create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
     options?: BaseMutationOptions
   ): Observable<SanityDocument<R>>
@@ -1100,7 +1222,7 @@ export class ObservableSanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  createIfNotExists<R = any>(
+  createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: FirstDocumentMutationOptions
   ): Observable<SanityDocument<R>>
@@ -1112,7 +1234,7 @@ export class ObservableSanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  createIfNotExists<R = any>(
+  createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: AllDocumentsMutationOptions
   ): Observable<SanityDocument<R>[]>
@@ -1124,7 +1246,7 @@ export class ObservableSanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  createIfNotExists<R = any>(
+  createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: FirstDocumentIdMutationOptions
   ): Observable<SingleMutationResult>
@@ -1136,7 +1258,7 @@ export class ObservableSanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  createIfNotExists<R = any>(
+  createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: AllDocumentIdsMutationOptions
   ): Observable<MultipleMutationResult>
@@ -1148,7 +1270,7 @@ export class ObservableSanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  createIfNotExists<R = any>(
+  createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options?: BaseMutationOptions
   ): Observable<SanityDocument<R>>
@@ -1160,7 +1282,7 @@ export class ObservableSanityClient {
    * @param document Document to either create or replace
    * @param options Mutation options
    */
-  createOrReplace<R = any>(
+  createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: FirstDocumentMutationOptions
   ): Observable<SanityDocument<R>>
@@ -1172,7 +1294,7 @@ export class ObservableSanityClient {
    * @param document Document to either create or replace
    * @param options Mutation options
    */
-  createOrReplace<R = any>(
+  createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: AllDocumentsMutationOptions
   ): Observable<SanityDocument<R>[]>
@@ -1184,7 +1306,7 @@ export class ObservableSanityClient {
    * @param document Document to either create or replace
    * @param options Mutation options
    */
-  createOrReplace<R = any>(
+  createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: FirstDocumentIdMutationOptions
   ): Observable<SingleMutationResult>
@@ -1196,7 +1318,7 @@ export class ObservableSanityClient {
    * @param document Document to either create or replace
    * @param options Mutation options
    */
-  createOrReplace<R = any>(
+  createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: AllDocumentIdsMutationOptions
   ): Observable<MultipleMutationResult>
@@ -1208,7 +1330,7 @@ export class ObservableSanityClient {
    * @param document Document to either create or replace
    * @param options Mutation options
    */
-  createOrReplace<R = any>(
+  createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options?: BaseMutationOptions
   ): Observable<SanityDocument<R>>
@@ -1220,7 +1342,10 @@ export class ObservableSanityClient {
    * @param id Document ID to delete
    * @param options Options for the mutation
    */
-  delete<R = any>(id: string, options: FirstDocumentMutationOptions): Observable<SanityDocument<R>>
+  delete<R extends Record<string, any> = Record<string, any>>(
+    id: string,
+    options: FirstDocumentMutationOptions
+  ): Observable<SanityDocument<R>>
 
   /**
    * Deletes a document with the given document ID.
@@ -1229,7 +1354,10 @@ export class ObservableSanityClient {
    * @param id Document ID to delete
    * @param options Options for the mutation
    */
-  delete<R = any>(id: string, options: AllDocumentsMutationOptions): Observable<SanityDocument<R>[]>
+  delete<R extends Record<string, any> = Record<string, any>>(
+    id: string,
+    options: AllDocumentsMutationOptions
+  ): Observable<SanityDocument<R>[]>
 
   /**
    * Deletes a document with the given document ID.
@@ -1256,7 +1384,10 @@ export class ObservableSanityClient {
    * @param id Document ID to delete
    * @param options Options for the mutation
    */
-  delete<R = any>(id: string, options?: BaseMutationOptions): Observable<SanityDocument<R>>
+  delete<R extends Record<string, any> = Record<string, any>>(
+    id: string,
+    options?: BaseMutationOptions
+  ): Observable<SanityDocument<R>>
 
   /**
    * Deletes one or more documents matching the given query or document ID.
@@ -1265,7 +1396,7 @@ export class ObservableSanityClient {
    * @param selection An object with either an `id` or `query` key defining what to delete
    * @param options Options for the mutation
    */
-  delete<R = any>(
+  delete<R extends Record<string, any> = Record<string, any>>(
     selection: MutationSelection,
     options: FirstDocumentMutationOptions
   ): Observable<SanityDocument<R>>
@@ -1277,7 +1408,7 @@ export class ObservableSanityClient {
    * @param selection An object with either an `id` or `query` key defining what to delete
    * @param options Options for the mutation
    */
-  delete<R = any>(
+  delete<R extends Record<string, any> = Record<string, any>>(
     selection: MutationSelection,
     options: AllDocumentsMutationOptions
   ): Observable<SanityDocument<R>[]>
@@ -1313,7 +1444,7 @@ export class ObservableSanityClient {
    * @param selection An object with either an `id` or `query` key defining what to delete
    * @param options Options for the mutation
    */
-  delete<R = any>(
+  delete<R extends Record<string, any> = Record<string, any>>(
     selection: MutationSelection,
     options?: BaseMutationOptions
   ): Observable<SanityDocument<R>>
@@ -1325,7 +1456,7 @@ export class ObservableSanityClient {
    * @param operations Mutation operations to execute
    * @param options Mutation options
    */
-  mutate<R = any>(
+  mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | Patch | Transaction,
     options: FirstDocumentMutationOptions
   ): Observable<SanityDocument<R>>
@@ -1337,7 +1468,7 @@ export class ObservableSanityClient {
    * @param operations Mutation operations to execute
    * @param options Mutation options
    */
-  mutate<R = any>(
+  mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | Patch | Transaction,
     options: AllDocumentsMutationOptions
   ): Observable<SanityDocument<R>[]>
@@ -1349,7 +1480,7 @@ export class ObservableSanityClient {
    * @param operations Mutation operations to execute
    * @param options Mutation options
    */
-  mutate<R = any>(
+  mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | Patch | Transaction,
     options: FirstDocumentIdMutationOptions
   ): Observable<SingleMutationResult>
@@ -1361,7 +1492,7 @@ export class ObservableSanityClient {
    * @param operations Mutation operations to execute
    * @param options Mutation options
    */
-  mutate<R = any>(
+  mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | Patch | Transaction,
     options: AllDocumentIdsMutationOptions
   ): Observable<MultipleMutationResult>
@@ -1373,7 +1504,7 @@ export class ObservableSanityClient {
    * @param operations Mutation operations to execute
    * @param options Mutation options
    */
-  mutate<R = any>(
+  mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | Patch | Transaction,
     options?: BaseMutationOptions
   ): Observable<SanityDocument<R>>
@@ -1384,14 +1515,16 @@ export class ObservableSanityClient {
    * @param documentId Document ID to patch
    * @param operations Optional object of patch operations to initialize the patch instance with
    */
-  patch(documentId: string | MutationSelection, operations?: PatchOperations): Patch
+  patch(documentId: string | MutationSelection, operations?: PatchOperations): ObservablePatch
 
   /**
    * Create a new transaction of mutations
    *
    * @param operations Optional array of mutation operations to initialize the transaction instance with
    */
-  transaction<R = any>(operations?: Mutation<R>[]): Transaction
+  transaction<R extends Record<string, any> = Record<string, any>>(
+    operations?: Mutation<R>[]
+  ): ObservableTransaction
 
   // "Internals", should generally not be used externally
   /**
@@ -1428,14 +1561,9 @@ export class ObservableSanityClient {
   request<T = any>(options: RawRequestOptions): Observable<T>
 }
 
-export class SanityClient {
-  static Patch: typeof Patch
-  static Transaction: typeof Transaction
-  static ClientError: typeof ClientError
-  static ServerError: typeof ServerError
-  static requester: GetItRequester
+export interface SanityClient {
   // Client/configuration
-  constructor(config: ClientConfig)
+  constructor(config: ClientConfig): SanityClient
 
   /**
    * Clone the client - returns a new instance
@@ -1613,7 +1741,10 @@ export class SanityClient {
    * @param params Optional query parameters
    * @param options Listener options
    */
-  listen<R = any>(query: string, params?: QueryParams): Observable<MutationEvent<R>>
+  listen<R extends Record<string, any> = Record<string, any>>(
+    query: string,
+    params?: QueryParams
+  ): Observable<MutationEvent<R>>
 
   /**
    * Set up a listener that will be notified when mutations occur on documents matching the provided query/filter.
@@ -1622,7 +1753,7 @@ export class SanityClient {
    * @param params Optional query parameters
    * @param options Listener options
    */
-  listen<R = any>(
+  listen<R extends Record<string, any> = Record<string, any>>(
     query: string,
     params?: QueryParams,
     options?: ListenOptions
@@ -1675,7 +1806,10 @@ export class SanityClient {
    * @param id Document ID to fetch
    * @param options Request options
    */
-  getDocument<R = any>(id: string, options?: {tag?: string}): Promise<SanityDocument<R> | undefined>
+  getDocument<R extends Record<string, any> = Record<string, any>>(
+    id: string,
+    options?: {tag?: string}
+  ): Promise<SanityDocument<R> | undefined>
 
   /**
    * Fetch multiple documents in one request.
@@ -1686,7 +1820,7 @@ export class SanityClient {
    * @param ids Document IDs to fetch
    * @param options Request options
    */
-  getDocuments<R = any>(
+  getDocuments<R extends Record<string, any> = Record<string, any>>(
     ids: string[],
     options?: {tag?: string}
   ): Promise<(SanityDocument<R> | null)[]>
@@ -1698,7 +1832,7 @@ export class SanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  create<R = any>(
+  create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
     options: FirstDocumentMutationOptions
   ): Promise<SanityDocument<R>>
@@ -1710,7 +1844,7 @@ export class SanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  create<R = any>(
+  create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
     options: AllDocumentsMutationOptions
   ): Promise<SanityDocument<R>[]>
@@ -1722,7 +1856,7 @@ export class SanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  create<R = any>(
+  create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
     options: FirstDocumentIdMutationOptions
   ): Promise<SingleMutationResult>
@@ -1734,7 +1868,7 @@ export class SanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  create<R = any>(
+  create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
     options: AllDocumentIdsMutationOptions
   ): Promise<MultipleMutationResult>
@@ -1746,7 +1880,7 @@ export class SanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  create<R = any>(
+  create<R extends Record<string, any> = Record<string, any>>(
     document: SanityDocumentStub<R>,
     options?: BaseMutationOptions
   ): Promise<SanityDocument<R>>
@@ -1758,7 +1892,7 @@ export class SanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  createIfNotExists<R = any>(
+  createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: FirstDocumentMutationOptions
   ): Promise<SanityDocument<R>>
@@ -1770,7 +1904,7 @@ export class SanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  createIfNotExists<R = any>(
+  createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: AllDocumentsMutationOptions
   ): Promise<SanityDocument<R>[]>
@@ -1782,7 +1916,7 @@ export class SanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  createIfNotExists<R = any>(
+  createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: FirstDocumentIdMutationOptions
   ): Promise<SingleMutationResult>
@@ -1794,7 +1928,7 @@ export class SanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  createIfNotExists<R = any>(
+  createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: AllDocumentIdsMutationOptions
   ): Promise<MultipleMutationResult>
@@ -1806,7 +1940,7 @@ export class SanityClient {
    * @param document Document to create
    * @param options Mutation options
    */
-  createIfNotExists<R = any>(
+  createIfNotExists<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options?: BaseMutationOptions
   ): Promise<SanityDocument<R>>
@@ -1818,7 +1952,7 @@ export class SanityClient {
    * @param document Document to either create or replace
    * @param options Mutation options
    */
-  createOrReplace<R = any>(
+  createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: FirstDocumentMutationOptions
   ): Promise<SanityDocument<R>>
@@ -1830,7 +1964,7 @@ export class SanityClient {
    * @param document Document to either create or replace
    * @param options Mutation options
    */
-  createOrReplace<R = any>(
+  createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: AllDocumentsMutationOptions
   ): Promise<SanityDocument<R>[]>
@@ -1842,7 +1976,7 @@ export class SanityClient {
    * @param document Document to either create or replace
    * @param options Mutation options
    */
-  createOrReplace<R = any>(
+  createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: FirstDocumentIdMutationOptions
   ): Promise<SingleMutationResult>
@@ -1854,7 +1988,7 @@ export class SanityClient {
    * @param document Document to either create or replace
    * @param options Mutation options
    */
-  createOrReplace<R = any>(
+  createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options: AllDocumentIdsMutationOptions
   ): Promise<MultipleMutationResult>
@@ -1866,7 +2000,7 @@ export class SanityClient {
    * @param document Document to either create or replace
    * @param options Mutation options
    */
-  createOrReplace<R = any>(
+  createOrReplace<R extends Record<string, any> = Record<string, any>>(
     document: IdentifiedSanityDocumentStub<R>,
     options?: BaseMutationOptions
   ): Promise<SanityDocument<R>>
@@ -1878,7 +2012,10 @@ export class SanityClient {
    * @param id Document ID to delete
    * @param options Options for the mutation
    */
-  delete<R = any>(id: string, options: FirstDocumentMutationOptions): Promise<SanityDocument<R>>
+  delete<R extends Record<string, any> = Record<string, any>>(
+    id: string,
+    options: FirstDocumentMutationOptions
+  ): Promise<SanityDocument<R>>
 
   /**
    * Deletes a document with the given document ID.
@@ -1887,7 +2024,10 @@ export class SanityClient {
    * @param id Document ID to delete
    * @param options Options for the mutation
    */
-  delete<R = any>(id: string, options: AllDocumentsMutationOptions): Promise<SanityDocument<R>[]>
+  delete<R extends Record<string, any> = Record<string, any>>(
+    id: string,
+    options: AllDocumentsMutationOptions
+  ): Promise<SanityDocument<R>[]>
 
   /**
    * Deletes a document with the given document ID.
@@ -1914,7 +2054,10 @@ export class SanityClient {
    * @param id Document ID to delete
    * @param options Options for the mutation
    */
-  delete<R = any>(id: string, options?: BaseMutationOptions): Promise<SanityDocument<R>>
+  delete<R extends Record<string, any> = Record<string, any>>(
+    id: string,
+    options?: BaseMutationOptions
+  ): Promise<SanityDocument<R>>
 
   /**
    * Deletes one or more documents matching the given query or document ID.
@@ -1923,7 +2066,7 @@ export class SanityClient {
    * @param selection An object with either an `id` or `query` key defining what to delete
    * @param options Options for the mutation
    */
-  delete<R = any>(
+  delete<R extends Record<string, any> = Record<string, any>>(
     selection: MutationSelection,
     options: FirstDocumentMutationOptions
   ): Promise<SanityDocument<R>>
@@ -1935,7 +2078,7 @@ export class SanityClient {
    * @param selection An object with either an `id` or `query` key defining what to delete
    * @param options Options for the mutation
    */
-  delete<R = any>(
+  delete<R extends Record<string, any> = Record<string, any>>(
     selection: MutationSelection,
     options: AllDocumentsMutationOptions
   ): Promise<SanityDocument<R>[]>
@@ -1971,7 +2114,7 @@ export class SanityClient {
    * @param selection An object with either an `id` or `query` key defining what to delete
    * @param options Options for the mutation
    */
-  delete<R = any>(
+  delete<R extends Record<string, any> = Record<string, any>>(
     selection: MutationSelection,
     options?: BaseMutationOptions
   ): Promise<SanityDocument<R>>
@@ -1983,7 +2126,7 @@ export class SanityClient {
    * @param operations Mutation operations to execute
    * @param options Mutation options
    */
-  mutate<R = any>(
+  mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | Patch | Transaction,
     options: FirstDocumentMutationOptions
   ): Promise<SanityDocument<R>>
@@ -1995,7 +2138,7 @@ export class SanityClient {
    * @param operations Mutation operations to execute
    * @param options Mutation options
    */
-  mutate<R = any>(
+  mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | Patch | Transaction,
     options: AllDocumentsMutationOptions
   ): Promise<SanityDocument<R>[]>
@@ -2007,7 +2150,7 @@ export class SanityClient {
    * @param operations Mutation operations to execute
    * @param options Mutation options
    */
-  mutate<R = any>(
+  mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | Patch | Transaction,
     options: FirstDocumentIdMutationOptions
   ): Promise<SingleMutationResult>
@@ -2019,7 +2162,7 @@ export class SanityClient {
    * @param operations Mutation operations to execute
    * @param options Mutation options
    */
-  mutate<R>(
+  mutate<R extends Record<string, any>>(
     operations: Mutation<R>[] | Patch | Transaction,
     options: AllDocumentIdsMutationOptions
   ): Promise<MultipleMutationResult>
@@ -2031,7 +2174,7 @@ export class SanityClient {
    * @param operations Mutation operations to execute
    * @param options Mutation options
    */
-  mutate<R = any>(
+  mutate<R extends Record<string, any> = Record<string, any>>(
     operations: Mutation<R>[] | Patch | Transaction,
     options?: BaseMutationOptions
   ): Promise<SanityDocument<R>>
@@ -2049,7 +2192,9 @@ export class SanityClient {
    *
    * @param operations Optional array of mutation operations to initialize the transaction instance with
    */
-  transaction<R = any>(operations?: Mutation<R>[]): Transaction
+  transaction<R extends Record<string, any> = Record<string, any>>(
+    operations?: Mutation<R>[]
+  ): Transaction
 
   // "Internals", should generally not be used externally
   /**
@@ -2096,4 +2241,16 @@ export class SanityClient {
   dataRequest(endpoint: string, body: unknown, options?: BaseMutationOptions): Promise<any>
 }
 
-export function createClient(config: ClientConfig): SanityClient
+export interface ClientConstructor {
+  Patch: typeof Patch
+  Transaction: typeof Transaction
+  ClientError: typeof ClientError
+  ServerError: typeof ServerError
+  requester: GetItRequester
+
+  new (config: ClientConfig): SanityClient
+  (config: ClientConfig): SanityClient
+}
+
+declare const SanityClientConstructor: ClientConstructor
+export default SanityClientConstructor