@sanity/client 5.0.0-esm.9 → 5.0.0

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="node" />
 
-import {BaseError} from 'make-error'
 import {Observable} from 'rxjs'
 import {Requester} from 'get-it'
 
@@ -33,7 +32,7 @@ export declare class AssetsClient {
   /**
    * Uploads a file asset to the configured dataset
    *
-   * @param assetType - Asset type (file/image)
+   * @param assetType - Asset type (file)
    * @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
    */
@@ -45,7 +44,7 @@ export declare class AssetsClient {
   /**
    * Uploads an image asset to the configured dataset
    *
-   * @param assetType - Asset type (file/image)
+   * @param assetType - Asset type (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
    */
@@ -54,6 +53,18 @@ export declare class AssetsClient {
     body: File | Blob | Buffer | NodeJS.ReadableStream,
     options?: UploadClientConfig
   ): Promise<SanityImageAssetDocument>
+  /**
+   * Uploads a file or 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
+   */
+  upload(
+    assetType: 'file' | 'image',
+    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    options?: UploadClientConfig
+  ): Promise<SanityAssetDocument | SanityImageAssetDocument>
 }
 
 /** @internal */
@@ -61,20 +72,6 @@ export declare type AttributeSet = {
   [key: string]: FIXME
 }
 
-/** @internal */
-export declare class AuthClient {
-  #private
-  constructor(client: SanityClient, httpRequest: HttpRequest)
-  /**
-   * Fetch available login providers
-   */
-  getLoginProviders(): Promise<AuthProviderResponse>
-  /**
-   * Revoke the configured session/token
-   */
-  logout(): Promise<void>
-}
-
 /** @internal */
 export declare interface AuthProvider {
   name: string
@@ -102,14 +99,6 @@ export declare class BasePatch {
   protected selection: PatchSelection
   protected operations: PatchOperations
   constructor(selection: PatchSelection, operations?: PatchOperations)
-  /**
-   * DEPRECATED: Don't use.
-   * The operation is added to the current patch, ready to be commited by `commit()`
-   *
-   * @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()`
@@ -178,7 +167,7 @@ export declare class BasePatch {
    * @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 FIXME elements, splice() will only remove elements from the array.
+   * @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?: FIXME[]): this
   /**
@@ -296,7 +285,7 @@ export declare interface ClientConfig {
 }
 
 /** @public */
-export declare class ClientError extends BaseError {
+export declare class ClientError extends Error {
   response: ErrorProps['response']
   statusCode: ErrorProps['statusCode']
   responseBody: ErrorProps['responseBody']
@@ -473,7 +462,7 @@ export declare type InsertPatch =
  * @internal
  */
 export declare function _listen<R extends Record<string, FIXME> = Record<string, FIXME>>(
-  this: SanityClient,
+  this: SanityClient | ObservableSanityClient,
   query: string,
   params?: QueryParams
 ): Observable<MutationEvent_2<R>>
@@ -487,7 +476,7 @@ export declare function _listen<R extends Record<string, FIXME> = Record<string,
  * @internal
  */
 export declare function _listen<R extends Record<string, FIXME> = Record<string, FIXME>>(
-  this: SanityClient,
+  this: SanityClient | ObservableSanityClient,
   query: string,
   params?: QueryParams,
   options?: ListenOptions
@@ -584,7 +573,7 @@ export declare class ObservableAssetsClient {
   /**
    * Uploads a file asset to the configured dataset
    *
-   * @param assetType - Asset type (file/image)
+   * @param assetType - Asset type (file)
    * @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
    */
@@ -600,7 +589,7 @@ export declare class ObservableAssetsClient {
   /**
    * Uploads an image asset to the configured dataset
    *
-   * @param assetType - Asset type (file/image)
+   * @param assetType - Asset type (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
    */
@@ -613,20 +602,22 @@ export declare class ObservableAssetsClient {
       document: SanityImageAssetDocument
     }>
   >
-}
-
-/** @internal */
-export declare class ObservableAuthClient {
-  #private
-  constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
-  /**
-   * Fetch available login providers
-   */
-  getLoginProviders(): Observable<AuthProviderResponse>
   /**
-   * Revoke the configured session/token
+   * Uploads a file or 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
    */
-  logout(): Observable<void>
+  upload(
+    assetType: 'file' | 'image',
+    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    options?: UploadClientConfig
+  ): Observable<
+    HttpRequestEvent<{
+      document: SanityAssetDocument | SanityImageAssetDocument
+    }>
+  >
 }
 
 /** @internal */
@@ -744,10 +735,13 @@ export declare class ObservableProjectsClient {
 export declare class ObservableSanityClient {
   #private
   assets: ObservableAssetsClient
-  auth: ObservableAuthClient
   datasets: ObservableDatasetsClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
+  /**
+   * Instance properties
+   */
+  listen: typeof _listen
   constructor(httpRequest: HttpRequest, config?: ClientConfig)
   /**
    * Clone the client - returns a new instance
@@ -779,7 +773,7 @@ export declare class ObservableSanityClient {
    * @param query - GROQ-query to perform
    * @param params - Query parameters
    */
-  fetch<R = FIXME>(query: string, params: QueryParams): Observable<R>
+  fetch<R = FIXME, Q = QueryParams>(query: string, params: Q): Observable<R>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -787,9 +781,9 @@ export declare class ObservableSanityClient {
    * @param params - Query parameters
    * @param options - Request options
    */
-  fetch<R = FIXME>(
+  fetch<R = FIXME, Q = QueryParams>(
     query: string,
-    params: QueryParams | undefined,
+    params: Q | undefined,
     options: FilteredResponseQueryOptions
   ): Observable<R>
   /**
@@ -799,9 +793,9 @@ export declare class ObservableSanityClient {
    * @param params - Query parameters
    * @param options - Request options
    */
-  fetch<R = FIXME>(
+  fetch<R = FIXME, Q = QueryParams>(
     query: string,
-    params: QueryParams | undefined,
+    params: Q | undefined,
     options: UnfilteredResponseQueryOptions
   ): Observable<RawQueryResponse<R>>
   /**
@@ -820,7 +814,7 @@ export declare class ObservableSanityClient {
    * Fetch multiple documents in one request.
    * Should be used sparingly - performing a query is usually a better option.
    * The order/position of documents is preserved based on the original array of IDs.
-   * If a FIXME of the documents are missing, they will be replaced by a `null` entry in the returned array
+   * If any of the documents are missing, they will be replaced by a `null` entry in the returned array
    *
    * @param ids - Document IDs to fetch
    * @param options - Request options
@@ -1445,7 +1439,6 @@ export declare interface SanityAssetDocument extends SanityDocument {
 export declare class SanityClient {
   #private
   assets: AssetsClient
-  auth: AuthClient
   datasets: DatasetsClient
   projects: ProjectsClient
   users: UsersClient
@@ -1488,7 +1481,7 @@ export declare class SanityClient {
    * @param query - GROQ-query to perform
    * @param params - Optional query parameters
    */
-  fetch<R = FIXME>(query: string, params: QueryParams): Promise<R>
+  fetch<R = FIXME, Q = QueryParams>(query: string, params: Q): Promise<R>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -1496,9 +1489,9 @@ export declare class SanityClient {
    * @param params - Optional query parameters
    * @param options - Request options
    */
-  fetch<R = FIXME>(
+  fetch<R = FIXME, Q = QueryParams>(
     query: string,
-    params: QueryParams | undefined,
+    params: Q | undefined,
     options: FilteredResponseQueryOptions
   ): Promise<R>
   /**
@@ -1508,9 +1501,9 @@ export declare class SanityClient {
    * @param params - Optional query parameters
    * @param options - Request options
    */
-  fetch<R = FIXME>(
+  fetch<R = FIXME, Q = QueryParams>(
     query: string,
-    params: QueryParams | undefined,
+    params: Q | undefined,
     options: UnfilteredResponseQueryOptions
   ): Promise<RawQueryResponse<R>>
   /**
@@ -1529,7 +1522,7 @@ export declare class SanityClient {
    * Fetch multiple documents in one request.
    * Should be used sparingly - performing a query is usually a better option.
    * The order/position of documents is preserved based on the original array of IDs.
-   * If a FIXME of the documents are missing, they will be replaced by a `null` entry in the returned array
+   * If any of the documents are missing, they will be replaced by a `null` entry in the returned array
    *
    * @param ids - Document IDs to fetch
    * @param options - Request options
@@ -2005,7 +1998,7 @@ export declare interface SanityUser {
 }
 
 /** @public */
-export declare class ServerError extends BaseError {
+export declare class ServerError extends Error {
   response: ErrorProps['response']
   statusCode: ErrorProps['statusCode']
   responseBody: ErrorProps['responseBody']