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

package/src/datasets/DatasetsClient.ts

@@ -1,11 +1,18 @@
-import {type Observable} from 'rxjs'
+import {type Observable, lastValueFrom} from 'rxjs'
 
+import {_request} from '../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
-import type {DatasetAclMode, DatasetResponse, DatasetsResponse} from '../types'
+import type {DatasetAclMode, DatasetResponse, DatasetsResponse, HttpRequest} from '../types'
 import * as validate from '../validators'
 
-export class BaseDatasetsClient {
-  client: SanityClient | ObservableSanityClient
+/** @internal */
+export class ObservableDatasetsClient {
+  #client: ObservableSanityClient
+  #httpRequest: HttpRequest
+  constructor(client: ObservableSanityClient, httpRequest: HttpRequest) {
+    this.#client = client
+    this.#httpRequest = httpRequest
+  }
 
   /**
    * Create a new dataset with the given name
@@ -13,21 +20,8 @@ export class BaseDatasetsClient {
    * @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>
-  create(
-    name: string,
-    options?: {aclMode?: DatasetAclMode}
-  ): Promise<DatasetResponse> | Observable<DatasetResponse> {
-    return this.#_modify('PUT', name, options)
+  create(name: string, options?: {aclMode?: DatasetAclMode}): Observable<DatasetResponse> {
+    return _modify<DatasetResponse>(this.#client, this.#httpRequest, 'PUT', name, options)
   }
 
   /**
@@ -36,21 +30,8 @@ export class BaseDatasetsClient {
    * @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>
-  edit(
-    name: string,
-    options?: {aclMode?: DatasetAclMode}
-  ): Promise<DatasetResponse> | Observable<DatasetResponse> {
-    return this.#_modify('PATCH', name, options)
+  edit(name: string, options?: {aclMode?: DatasetAclMode}): Observable<DatasetResponse> {
+    return _modify<DatasetResponse>(this.#client, this.#httpRequest, 'PATCH', name, options)
   }
 
   /**
@@ -58,40 +39,77 @@ export class BaseDatasetsClient {
    *
    * @param name - Name of the dataset to delete
    */
-  delete(this: DatasetsClient, name: string): Promise<{deleted: true}>
-  delete(this: ObservableDatasetsClient, name: string): Observable<{deleted: true}>
-  delete(name: string): Promise<{deleted: true}> | Observable<{deleted: true}> {
-    return this.#_modify('DELETE', name)
+  delete(name: string): Observable<{deleted: true}> {
+    return _modify<{deleted: true}>(this.#client, this.#httpRequest, 'DELETE', name)
   }
 
   /**
    * Fetch a list of datasets for the configured project
    */
-  list(this: DatasetsClient): Promise<DatasetsResponse>
-  list(this: ObservableDatasetsClient): Observable<DatasetsResponse>
-  list(): Promise<DatasetsResponse> | Observable<DatasetsResponse> {
-    return this.client.request({uri: '/datasets'})
+  list(): Observable<DatasetsResponse> {
+    return _request<DatasetsResponse>(this.#client, this.#httpRequest, {uri: '/datasets'})
   }
+}
 
-  #_modify(method: 'DELETE' | 'PATCH' | 'PUT', name: string, options?: {aclMode?: DatasetAclMode}) {
-    validate.dataset(name)
-    return this.client.request({method, uri: `/datasets/${name}`, body: options})
+/** @internal */
+export class DatasetsClient {
+  #client: SanityClient
+  #httpRequest: HttpRequest
+  constructor(client: SanityClient, httpRequest: HttpRequest) {
+    this.#client = client
+    this.#httpRequest = httpRequest
   }
-}
 
-export class ObservableDatasetsClient extends BaseDatasetsClient {
-  client: ObservableSanityClient
+  /**
+   * 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> {
+    return lastValueFrom(
+      _modify<DatasetResponse>(this.#client, this.#httpRequest, 'PUT', name, options)
+    )
+  }
 
-  constructor(client: ObservableSanityClient) {
-    super()
-    this.client = client
+  /**
+   * 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> {
+    return lastValueFrom(
+      _modify<DatasetResponse>(this.#client, this.#httpRequest, 'PATCH', name, options)
+    )
+  }
+
+  /**
+   * Delete a dataset with the given name
+   *
+   * @param name - Name of the dataset to delete
+   */
+  delete(name: string): Promise<{deleted: true}> {
+    return lastValueFrom(_modify<{deleted: true}>(this.#client, this.#httpRequest, 'DELETE', name))
   }
-}
 
-export class DatasetsClient extends BaseDatasetsClient {
-  client: SanityClient
-  constructor(client: SanityClient) {
-    super()
-    this.client = client
+  /**
+   * Fetch a list of datasets for the configured project
+   */
+  list(): Promise<DatasetsResponse> {
+    return lastValueFrom(
+      _request<DatasetsResponse>(this.#client, this.#httpRequest, {uri: '/datasets'})
+    )
   }
 }
+
+function _modify<R = unknown>(
+  client: SanityClient | ObservableSanityClient,
+  httpRequest: HttpRequest,
+  method: 'DELETE' | 'PATCH' | 'PUT',
+  name: string,
+  options?: {aclMode?: DatasetAclMode}
+) {
+  validate.dataset(name)
+  return _request<R>(client, httpRequest, {method, uri: `/datasets/${name}`, body: options})
+}

package/src/http/errors.ts

@@ -2,6 +2,7 @@ import {BaseError} from 'make-error'
 
 import {ErrorProps} from '../types'
 
+/** @public */
 export class ClientError extends BaseError {
   response: ErrorProps['response']
   statusCode: ErrorProps['statusCode'] = 400
@@ -15,6 +16,7 @@ export class ClientError extends BaseError {
   }
 }
 
+/** @public */
 export class ServerError extends BaseError {
   response: ErrorProps['response']
   statusCode: ErrorProps['statusCode'] = 500

package/src/http/request.ts

@@ -26,9 +26,7 @@ const printWarnings = {
   },
 }
 
-/**
- * @param envMiddleware Environment-specific middleware.
- */
+/** @internal */
 export function defineHttpRequest(envMiddleware: Middlewares): HttpRequest {
   const request = getIt([
     ...envMiddleware,

package/src/index.browser.ts

@@ -11,8 +11,8 @@ export * from './types'
 
 // Set the http client to use for requests, and its environment specific middleware
 const httpRequest = defineHttpRequest(envMiddleware)
+/** @public */
 export const requester = httpRequest.defaultRequester
 
-export function createClient(config: ClientConfig) {
-  return new SanityClient(httpRequest, config)
-}
+/** @public */
+export const createClient = (config: ClientConfig) => new SanityClient(httpRequest, config)

package/src/index.ts

@@ -11,47 +11,8 @@ export * from './types'
 
 // Set the http client to use for requests, and its environment specific middleware
 const httpRequest = defineHttpRequest(envMiddleware)
+/** @public */
 export const requester = httpRequest.defaultRequester
 
-export function createClient(config: ClientConfig) {
-  return new SanityClient(httpRequest, config)
-}
-
-/*
-const client = createClient({})
-
-client.auth.getLoginProviders().then
-client.observable.auth.getLoginProviders().subscribe
-
-client.create({_id: 'id', _type: 'document'}, {}).then()
-client.observable.create({_id: 'id', _type: 'document'}, {}).subscribe()
-
-client.delete('id', {returnFirst: true}).then
-
-client.config({projectId: 'my-project-id'})
-// @ts-expect-error -- isPromiseAPI isn't allowed
-client.config({projectId: 'my-project-id', isPromiseAPI: false})
-client.fetch('', {}).then
-// @ts-expect-error -- observable is not allowed
-client.fetch('', {}).subscribe
-client.observable.fetch('', {}).subscribe
-// @ts-expect-error -- promise is not allowed
-client.observable.fetch('', {}).then
-
-client.assets.upload('image', Buffer.from('')).then
-client.observable.assets.upload('image', Buffer.from('')).subscribe
-// @ts-expect-error -- promise not allowed
-client.observable.assets.upload('image', Buffer.from('')).then
-// @ts-expect-error -- protected property
-client.assets.isPromiseAPI()
-
-const observableClient = new ObservableSanityClient(httpRequest, {})
-observableClient.config({projectId: 'my-project-id'})
-// eslint-disable-next-line no-console
-console.log(observableClient.isPromiseAPI() === false)
-observableClient.fetch('', {}).subscribe
-// @ts-expect-error -- promise is not allowed
-observableClient.fetch('', {}).then
-// @ts-expect-error -- observable is not allowed
-observableClient.observable.fetch
-// */
+/** @public */
+export const createClient = (config: ClientConfig) => new SanityClient(httpRequest, config)

package/src/projects/ProjectsClient.ts

@@ -1,18 +1,23 @@
-import {type Observable} from 'rxjs'
+import {type Observable, lastValueFrom} from 'rxjs'
 
+import {_request} from '../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
-import type {SanityProject} from '../types'
+import type {HttpRequest, SanityProject} from '../types'
 
-export class BaseProjectsClient {
-  client: SanityClient | ObservableSanityClient
+/** @internal */
+export class ObservableProjectsClient {
+  #client: ObservableSanityClient
+  #httpRequest: HttpRequest
+  constructor(client: ObservableSanityClient, httpRequest: HttpRequest) {
+    this.#client = client
+    this.#httpRequest = httpRequest
+  }
 
   /**
    * Fetch a list of projects the authenticated user has access to
    */
-  list(this: ProjectsClient): Promise<SanityProject[]>
-  list(this: ObservableProjectsClient): Observable<SanityProject[]>
-  list(): Promise<SanityProject[]> | Observable<SanityProject[]> {
-    return this.client.request({uri: '/projects'})
+  list(): Observable<SanityProject[]> {
+    return _request<SanityProject[]>(this.#client, this.#httpRequest, {uri: '/projects'})
   }
 
   /**
@@ -20,26 +25,37 @@ export class BaseProjectsClient {
    *
    * @param projectId - ID of the project to fetch
    */
-  getById(this: ProjectsClient, projectId: string): Promise<SanityProject>
-  getById(this: ObservableProjectsClient, projectId: string): Observable<SanityProject>
-  getById(projectId: string): Promise<SanityProject> | Observable<SanityProject> {
-    return this.client.request({uri: `/projects/${projectId}`})
+  getById(projectId: string): Observable<SanityProject> {
+    return _request<SanityProject>(this.#client, this.#httpRequest, {uri: `/projects/${projectId}`})
   }
 }
 
-export class ObservableProjectsClient extends BaseProjectsClient {
-  client: ObservableSanityClient
+/** @internal */
+export class ProjectsClient {
+  #client: SanityClient
+  #httpRequest: HttpRequest
+  constructor(client: SanityClient, httpRequest: HttpRequest) {
+    this.#client = client
+    this.#httpRequest = httpRequest
+  }
 
-  constructor(client: ObservableSanityClient) {
-    super()
-    this.client = client
+  /**
+   * Fetch a list of projects the authenticated user has access to
+   */
+  list(): Promise<SanityProject[]> {
+    return lastValueFrom(
+      _request<SanityProject[]>(this.#client, this.#httpRequest, {uri: '/projects'})
+    )
   }
-}
 
-export class ProjectsClient extends BaseProjectsClient {
-  client: SanityClient
-  constructor(client: SanityClient) {
-    super()
-    this.client = client
+  /**
+   * Fetch a project by project ID
+   *
+   * @param projectId - ID of the project to fetch
+   */
+  getById(projectId: string): Promise<SanityProject> {
+    return lastValueFrom(
+      _request<SanityProject>(this.#client, this.#httpRequest, {uri: `/projects/${projectId}`})
+    )
   }
 }