@sanity/client 5.0.0-esm.0 → 5.0.0-esm.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "5.0.0-esm.0",
+  "version": "5.0.0-esm.2",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",

package/src/SanityClient.ts

@@ -1,7 +1,7 @@
 import {lastValueFrom, Observable} from 'rxjs'
 
 import {AssetsClient, ObservableAssetsClient} from './assets/AssetsClient'
-import {AuthClient, BaseAuthClient, ObservableAuthClient} from './auth/AuthClient'
+import {AuthClient, ObservableAuthClient} from './auth/AuthClient'
 import {initConfig} from './config'
 import * as dataMethods from './data/dataMethods'
 import {_listen} from './data/listen'
@@ -47,7 +47,6 @@ export type {
   _listen,
   AssetsClient,
   AuthClient,
-  BaseAuthClient,
   BaseDatasetsClient,
   BaseProjectsClient,
   BaseUsersClient,
@@ -61,68 +60,7 @@ export type {
   UsersClient,
 }
 
-export class BaseSanityClient {
-  #clientConfig: InitializedClientConfig
-
-  constructor(config: ClientConfig) {
-    this.config(config)
-  }
-
-  /** @internal */
-  protected config(newConfig?: Partial<ClientConfig>): ClientConfig | this {
-    if (newConfig === undefined) {
-      return {...this.#clientConfig}
-    }
-
-    if (this.#clientConfig && this.#clientConfig.allowReconfigure === false) {
-      throw new Error(
-        'Existing client instance cannot be reconfigured - use `withConfig(newConfig)` to return a new client'
-      )
-    }
-
-    this.#clientConfig = initConfig(newConfig, this.#clientConfig || {})
-    return this
-  }
-
-  /**
-   * Returns whether or not this client is using the Promise API (otherwise it is using observables)
-   * @internal
-   * @deprecated Internals, should not be used externally
-   */
-  // @TODO check if this can be deleted
-  isPromiseAPI(): this is SanityClient {
-    return this instanceof SanityClient
-  }
-
-  /**
-   * 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 = false) {
-    const base = canUseCdn ? this.#clientConfig.cdnUrl : this.#clientConfig.url
-    return `${base}/${uri.replace(/^\//, '')}`
-  }
-
-  /**
-   * 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 {
-    const config = this.config()
-    const catalog = validators.hasDataset(config)
-    const baseUri = `/${operation}/${catalog}`
-    const uri = path ? `${baseUri}/${path}` : baseUri
-    return `/data${uri}`.replace(/\/($|\?)/, '$1')
-  }
-}
-
-export class ObservableSanityClient extends BaseSanityClient {
+export class ObservableSanityClient {
   assets: ObservableAssetsClient
   auth: ObservableAuthClient
   datasets: ObservableDatasetsClient
@@ -132,15 +70,16 @@ export class ObservableSanityClient extends BaseSanityClient {
   /**
    * Private properties
    */
+  #clientConfig: InitializedClientConfig
   #httpRequest: HttpRequest
 
   constructor(httpRequest: HttpRequest, config: ClientConfig) {
-    super(config)
+    this.config(config)
 
     this.#httpRequest = httpRequest
 
     this.assets = new ObservableAssetsClient(this, this.#httpRequest)
-    this.auth = new ObservableAuthClient(this)
+    this.auth = new ObservableAuthClient(this, this.#httpRequest)
     this.datasets = new ObservableDatasetsClient(this)
     this.projects = new ObservableProjectsClient(this)
     this.users = new ObservableUsersClient(this)
@@ -162,7 +101,18 @@ export class ObservableSanityClient extends BaseSanityClient {
    */
   config(newConfig?: Partial<ClientConfig>): this
   config(newConfig?: Partial<ClientConfig>): ClientConfig | this {
-    return super.config(newConfig)
+    if (newConfig === undefined) {
+      return {...this.#clientConfig}
+    }
+
+    if (this.#clientConfig && this.#clientConfig.allowReconfigure === false) {
+      throw new Error(
+        'Existing client instance cannot be reconfigured - use `withConfig(newConfig)` to return a new client'
+      )
+    }
+
+    this.#clientConfig = initConfig(newConfig, this.#clientConfig || {})
+    return this
   }
 
   /**
@@ -672,9 +622,36 @@ export class ObservableSanityClient extends BaseSanityClient {
   request<R = any>(options: RawRequestOptions): Observable<R> {
     return dataMethods._request(this, this.#httpRequest, options)
   }
+
+  /**
+   * 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 = false) {
+    const base = canUseCdn ? this.#clientConfig.cdnUrl : this.#clientConfig.url
+    return `${base}/${uri.replace(/^\//, '')}`
+  }
+
+  /**
+   * 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 {
+    const config = this.config()
+    const catalog = validators.hasDataset(config)
+    const baseUri = `/${operation}/${catalog}`
+    const uri = path ? `${baseUri}/${path}` : baseUri
+    return `/data${uri}`.replace(/\/($|\?)/, '$1')
+  }
 }
 
-export class SanityClient extends BaseSanityClient {
+export class SanityClient {
   assets: AssetsClient
   auth: AuthClient
   datasets: DatasetsClient
@@ -689,6 +666,7 @@ export class SanityClient extends BaseSanityClient {
   /**
    * Private properties
    */
+  #clientConfig: InitializedClientConfig
   #httpRequest: HttpRequest
 
   /**
@@ -697,17 +675,17 @@ export class SanityClient extends BaseSanityClient {
   listen = _listen
 
   constructor(httpRequest: HttpRequest, config: ClientConfig) {
-    super(config)
+    this.observable = new ObservableSanityClient(httpRequest, config)
+
+    this.config(config)
 
     this.#httpRequest = httpRequest
 
     this.assets = new AssetsClient(this, this.#httpRequest)
-    this.auth = new AuthClient(this)
+    this.auth = new AuthClient(this, this.#httpRequest)
     this.datasets = new DatasetsClient(this)
     this.projects = new ProjectsClient(this)
     this.users = new UsersClient(this)
-
-    this.observable = new ObservableSanityClient(httpRequest, this.config())
   }
 
   /**
@@ -726,11 +704,20 @@ export class SanityClient extends BaseSanityClient {
    */
   config(newConfig?: Partial<ClientConfig>): this
   config(newConfig?: Partial<ClientConfig>): ClientConfig | this {
-    if (newConfig) {
-      this.observable.config(newConfig)
+    if (newConfig === undefined) {
+      return {...this.#clientConfig}
     }
 
-    return super.config(newConfig)
+    if (this.#clientConfig && this.#clientConfig.allowReconfigure === false) {
+      throw new Error(
+        'Existing client instance cannot be reconfigured - use `withConfig(newConfig)` to return a new client'
+      )
+    }
+
+    this.observable.config(newConfig)
+
+    this.#clientConfig = initConfig(newConfig, this.#clientConfig || {})
+    return this
   }
 
   /**
@@ -1258,4 +1245,31 @@ export class SanityClient extends BaseSanityClient {
   dataRequest(endpoint: string, body: unknown, options?: BaseMutationOptions): Promise<any> {
     return lastValueFrom(dataMethods._dataRequest(this, this.#httpRequest, endpoint, body, options))
   }
+
+  /**
+   * 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 = false) {
+    const base = canUseCdn ? this.#clientConfig.cdnUrl : this.#clientConfig.url
+    return `${base}/${uri.replace(/^\//, '')}`
+  }
+
+  /**
+   * 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 {
+    const config = this.config()
+    const catalog = validators.hasDataset(config)
+    const baseUri = `/${operation}/${catalog}`
+    const uri = path ? `${baseUri}/${path}` : baseUri
+    return `/data${uri}`.replace(/\/($|\?)/, '$1')
+  }
 }

package/src/auth/AuthClient.ts

@@ -1,43 +1,61 @@
-import {type Observable} from 'rxjs'
+import {type Observable, lastValueFrom} from 'rxjs'
 
+import * as dataMethods from '../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
-import type {AuthProviderResponse} from '../types'
+import type {AuthProviderResponse, HttpRequest} from '../types'
 
-export class BaseAuthClient {
-  client: SanityClient | ObservableSanityClient
+export class ObservableAuthClient {
+  #client: ObservableSanityClient
+  #httpRequest: HttpRequest
+  constructor(client: ObservableSanityClient, httpRequest: HttpRequest) {
+    this.#client = client
+    this.#httpRequest = httpRequest
+  }
 
   /**
    * Fetch available login providers
    */
-  getLoginProviders(this: AuthClient): Promise<AuthProviderResponse>
-  getLoginProviders(this: ObservableAuthClient): Observable<AuthProviderResponse>
-  getLoginProviders(): Promise<AuthProviderResponse> | Observable<AuthProviderResponse> {
-    return this.client.request({uri: '/auth/providers'})
+  getLoginProviders<R = AuthProviderResponse>(): Observable<R> {
+    return dataMethods._request<R>(this.#client, this.#httpRequest, {uri: '/auth/providers'})
   }
 
   /**
    * Revoke the configured session/token
    */
-  logout(this: AuthClient): Promise<any>
-  logout(this: ObservableAuthClient): Observable<any>
-  logout(): Promise<any> | Observable<any> {
-    return this.client.request({uri: '/auth/logout', method: 'POST'})
+  logout<R = any>(): Observable<R> {
+    return dataMethods._request<R>(this.#client, this.#httpRequest, {
+      uri: '/auth/logout',
+      method: 'POST',
+    })
   }
 }
 
-export class ObservableAuthClient extends BaseAuthClient {
-  client: ObservableSanityClient
+export class AuthClient {
+  #client: SanityClient
+  #httpRequest: HttpRequest
+  constructor(client: SanityClient, httpRequest: HttpRequest) {
+    this.#client = client
+    this.#httpRequest = httpRequest
+  }
 
-  constructor(client: ObservableSanityClient) {
-    super()
-    this.client = client
+  /**
+   * Fetch available login providers
+   */
+  getLoginProviders<R = AuthProviderResponse>(): Promise<R> {
+    return lastValueFrom(
+      dataMethods._request<R>(this.#client, this.#httpRequest, {uri: '/auth/providers'})
+    )
   }
-}
 
-export class AuthClient extends BaseAuthClient {
-  client: SanityClient
-  constructor(client: SanityClient) {
-    super()
-    this.client = client
+  /**
+   * Revoke the configured session/token
+   */
+  logout<R = any>(): Promise<R> {
+    return lastValueFrom(
+      dataMethods._request<R>(this.#client, this.#httpRequest, {
+        uri: '/auth/logout',
+        method: 'POST',
+      })
+    )
   }
 }