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

package/dist/index.d.ts

@@ -62,11 +62,11 @@ export declare class AuthClient {
   /**
    * Fetch available login providers
    */
-  getLoginProviders<R = AuthProviderResponse>(): Promise<R>
+  getLoginProviders(): Promise<AuthProviderResponse>
   /**
    * Revoke the configured session/token
    */
-  logout<R = any>(): Promise<R>
+  logout(): Promise<void>
 }
 
 export declare interface AuthProvider {
@@ -79,73 +79,6 @@ export declare type AuthProviderResponse = {
   providers: AuthProvider[]
 }
 
-export declare class BaseDatasetsClient {
-  #private
-  client: SanityClient | ObservableSanityClient
-  /**
-   * Create a new dataset with the given name
-   *
-   * @param name - Name of the dataset to create
-   * @param options - Options for the dataset
-   */
-  create(
-    this: DatasetsClient,
-    name: string,
-    options?: {
-      aclMode?: DatasetAclMode
-    }
-  ): Promise<DatasetResponse>
-  create(
-    this: ObservableDatasetsClient,
-    name: string,
-    options?: {
-      aclMode?: DatasetAclMode
-    }
-  ): Observable<DatasetResponse>
-  /**
-   * Edit a dataset with the given name
-   *
-   * @param name - Name of the dataset to edit
-   * @param options - New options for the dataset
-   */
-  edit(
-    this: DatasetsClient,
-    name: string,
-    options?: {
-      aclMode?: DatasetAclMode
-    }
-  ): Promise<DatasetResponse>
-  edit(
-    this: ObservableDatasetsClient,
-    name: string,
-    options?: {
-      aclMode?: DatasetAclMode
-    }
-  ): Observable<DatasetResponse>
-  /**
-   * Delete a dataset with the given name
-   *
-   * @param name - Name of the dataset to delete
-   */
-  delete(
-    this: DatasetsClient,
-    name: string
-  ): Promise<{
-    deleted: true
-  }>
-  delete(
-    this: ObservableDatasetsClient,
-    name: string
-  ): Observable<{
-    deleted: true
-  }>
-  /**
-   * Fetch a list of datasets for the configured project
-   */
-  list(this: DatasetsClient): Promise<DatasetsResponse>
-  list(this: ObservableDatasetsClient): Observable<DatasetsResponse>
-}
-
 export declare type BaseMutationOptions = RequestOptions & {
   visibility?: 'sync' | 'async' | 'deferred'
   returnDocuments?: boolean
@@ -260,22 +193,6 @@ export declare class BasePatch {
   protected _set(op: keyof PatchOperations, props: any): this
 }
 
-export declare class BaseProjectsClient {
-  client: SanityClient | ObservableSanityClient
-  /**
-   * Fetch a list of projects the authenticated user has access to
-   */
-  list(this: ProjectsClient): Promise<SanityProject[]>
-  list(this: ObservableProjectsClient): Observable<SanityProject[]>
-  /**
-   * Fetch a project by project ID
-   *
-   * @param projectId - ID of the project to fetch
-   */
-  getById(this: ProjectsClient, projectId: string): Promise<SanityProject>
-  getById(this: ObservableProjectsClient, projectId: string): Observable<SanityProject>
-}
-
 export declare class BaseTransaction {
   protected operations: Mutation[]
   protected trxId?: string
@@ -337,23 +254,6 @@ export declare class BaseTransaction {
   protected _add(mut: Mutation): this
 }
 
-export declare class BaseUsersClient {
-  client: SanityClient | ObservableSanityClient
-  /**
-   * Fetch a user by user ID
-   *
-   * @param id - User ID of the user to fetch. If `me` is provided, a minimal response including the users role is returned.
-   */
-  getById<T extends 'me' | string>(
-    this: UsersClient,
-    id: T
-  ): Promise<T extends 'me' ? CurrentSanityUser : SanityUser>
-  getById<T extends 'me' | string>(
-    this: ObservableUsersClient,
-    id: T
-  ): Observable<T extends 'me' ? CurrentSanityUser : SanityUser>
-}
-
 export declare type ChannelErrorEvent = {
   type: 'channelError'
   message: string
@@ -407,9 +307,45 @@ export declare type DatasetResponse = {
   aclMode: DatasetAclMode
 }
 
-export declare class DatasetsClient extends BaseDatasetsClient {
-  client: SanityClient
-  constructor(client: SanityClient)
+export declare class DatasetsClient {
+  #private
+  constructor(client: SanityClient, httpRequest: HttpRequest)
+  /**
+   * Create a new dataset with the given name
+   *
+   * @param name - Name of the dataset to create
+   * @param options - Options for the dataset
+   */
+  create(
+    name: string,
+    options?: {
+      aclMode?: DatasetAclMode
+    }
+  ): Promise<DatasetResponse>
+  /**
+   * Edit a dataset with the given name
+   *
+   * @param name - Name of the dataset to edit
+   * @param options - New options for the dataset
+   */
+  edit(
+    name: string,
+    options?: {
+      aclMode?: DatasetAclMode
+    }
+  ): Promise<DatasetResponse>
+  /**
+   * Delete a dataset with the given name
+   *
+   * @param name - Name of the dataset to delete
+   */
+  delete(name: string): Promise<{
+    deleted: true
+  }>
+  /**
+   * Fetch a list of datasets for the configured project
+   */
+  list(): Promise<DatasetsResponse>
 }
 
 export declare type DatasetsResponse = {
@@ -640,16 +576,52 @@ export declare class ObservableAuthClient {
   /**
    * Fetch available login providers
    */
-  getLoginProviders<R = AuthProviderResponse>(): Observable<R>
+  getLoginProviders(): Observable<AuthProviderResponse>
   /**
    * Revoke the configured session/token
    */
-  logout<R = any>(): Observable<R>
+  logout(): Observable<void>
 }
 
-export declare class ObservableDatasetsClient extends BaseDatasetsClient {
-  client: ObservableSanityClient
-  constructor(client: ObservableSanityClient)
+export declare class ObservableDatasetsClient {
+  #private
+  constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
+  /**
+   * Create a new dataset with the given name
+   *
+   * @param name - Name of the dataset to create
+   * @param options - Options for the dataset
+   */
+  create(
+    name: string,
+    options?: {
+      aclMode?: DatasetAclMode
+    }
+  ): Observable<DatasetResponse>
+  /**
+   * Edit a dataset with the given name
+   *
+   * @param name - Name of the dataset to edit
+   * @param options - New options for the dataset
+   */
+  edit(
+    name: string,
+    options?: {
+      aclMode?: DatasetAclMode
+    }
+  ): Observable<DatasetResponse>
+  /**
+   * Delete a dataset with the given name
+   *
+   * @param name - Name of the dataset to delete
+   */
+  delete(name: string): Observable<{
+    deleted: true
+  }>
+  /**
+   * Fetch a list of datasets for the configured project
+   */
+  list(): Observable<DatasetsResponse>
 }
 
 export declare class ObservablePatch extends BasePatch {
@@ -703,9 +675,19 @@ export declare class ObservablePatch extends BasePatch {
 
 export declare type ObservablePatchBuilder = (patch: ObservablePatch) => ObservablePatch
 
-export declare class ObservableProjectsClient extends BaseProjectsClient {
-  client: ObservableSanityClient
-  constructor(client: ObservableSanityClient)
+export declare class ObservableProjectsClient {
+  #private
+  constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
+  /**
+   * Fetch a list of projects the authenticated user has access to
+   */
+  list(): Observable<SanityProject[]>
+  /**
+   * Fetch a project by project ID
+   *
+   * @param projectId - ID of the project to fetch
+   */
+  getById(projectId: string): Observable<SanityProject>
 }
 
 export declare class ObservableSanityClient {
@@ -1144,22 +1126,6 @@ export declare class ObservableSanityClient {
    * @param options Request options
    */
   request<R = any>(options: RawRequestOptions): Observable<R>
-  /**
-   * DEPRECATED: Get a Sanity API URL for the URI provided
-   *
-   * @deprecated Should be an internal concern
-   * @param uri URI/path to build URL for
-   * @param canUseCdn Whether or not to allow using the API CDN for this route
-   */
-  getUrl(uri: string, canUseCdn?: boolean): string
-  /**
-   * DEPRECATED: Get a Sanity API URL for the data operation and path provided
-   *
-   * @deprecated Should be an internal concern
-   * @param operation Data operation
-   * @param path Path to append
-   */
-  getDataUrl(operation: string, path?: string): string
 }
 
 export declare class ObservableTransaction extends BaseTransaction {
@@ -1220,9 +1186,17 @@ export declare class ObservableTransaction extends BaseTransaction {
   patch(patch: ObservablePatch): this
 }
 
-export declare class ObservableUsersClient extends BaseUsersClient {
-  client: ObservableSanityClient
-  constructor(client: ObservableSanityClient)
+export declare class ObservableUsersClient {
+  #private
+  constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
+  /**
+   * Fetch a user by user ID
+   *
+   * @param id - User ID of the user to fetch. If `me` is provided, a minimal response including the users role is returned.
+   */
+  getById<T extends 'me' | string>(
+    id: T
+  ): Observable<T extends 'me' ? CurrentSanityUser : SanityUser>
 }
 
 export declare class Patch extends BasePatch {
@@ -1307,9 +1281,19 @@ declare interface ProgressEvent_2 {
 }
 export {ProgressEvent_2 as ProgressEvent}
 
-export declare class ProjectsClient extends BaseProjectsClient {
-  client: SanityClient
-  constructor(client: SanityClient)
+export declare class ProjectsClient {
+  #private
+  constructor(client: SanityClient, httpRequest: HttpRequest)
+  /**
+   * Fetch a list of projects the authenticated user has access to
+   */
+  list(): Promise<SanityProject[]>
+  /**
+   * Fetch a project by project ID
+   *
+   * @param projectId - ID of the project to fetch
+   */
+  getById(projectId: string): Promise<SanityProject>
 }
 
 export declare type QueryParams = {
@@ -1841,22 +1825,6 @@ export declare class SanityClient {
    * @param options Request options
    */
   dataRequest(endpoint: string, body: unknown, options?: BaseMutationOptions): Promise<any>
-  /**
-   * DEPRECATED: Get a Sanity API URL for the URI provided
-   *
-   * @deprecated Should be an internal concern
-   * @param uri URI/path to build URL for
-   * @param canUseCdn Whether or not to allow using the API CDN for this route
-   */
-  getUrl(uri: string, canUseCdn?: boolean): string
-  /**
-   * DEPRECATED: Get a Sanity API URL for the data operation and path provided
-   *
-   * @deprecated Should be an internal concern
-   * @param operation Data operation
-   * @param path Path to append
-   */
-  getDataUrl(operation: string, path?: string): string
 }
 
 export declare type SanityDocument<T extends Record<string, any> = Record<string, any>> = {
@@ -2123,9 +2091,15 @@ export declare interface UploadClientConfig {
   }
 }
 
-export declare class UsersClient extends BaseUsersClient {
-  client: SanityClient
-  constructor(client: SanityClient)
+export declare class UsersClient {
+  #private
+  constructor(client: SanityClient, httpRequest: HttpRequest)
+  /**
+   * Fetch a user by user ID
+   *
+   * @param id - User ID of the user to fetch. If `me` is provided, a minimal response including the users role is returned.
+   */
+  getById<T extends 'me' | string>(id: T): Promise<T extends 'me' ? CurrentSanityUser : SanityUser>
 }
 
 export declare type WelcomeEvent = {