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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "5.0.0-esm.1",
+  "version": "5.0.0-esm.3",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -22,8 +22,8 @@
   },
   "license": "MIT",
   "author": "Sanity.io <hello@sanity.io>",
-  "type": "module",
   "sideEffects": false,
+  "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -44,9 +44,9 @@
     "./package.json": "./package.json"
   },
   "main": "./dist/index.cjs",
+  "unpkg": "umd/sanityClient.min.js",
   "module": "./dist/index.js",
   "source": "./src/index.ts",
-  "unpkg": "umd/sanityClient.min.js",
   "browser": {
     "./dist/index.cjs": "./dist/index.browser.cjs",
     "./dist/index.js": "./dist/index.browser.js"
@@ -57,10 +57,6 @@
     "src",
     "umd"
   ],
-  "browserslist": [
-    "> 0.2% and supports es6-module and supports es6-module-dynamic-import and not dead and not IE 11",
-    "maintained node versions"
-  ],
   "scripts": {
     "prebuild": "npm run clean",
     "build": "pkg build --strict && pkg --strict && npm run rollup && npm run minify",
@@ -71,10 +67,14 @@
     "prepublishOnly": "npm run build",
     "rollup": "NODE_ENV=production rollup -c rollup.config.cjs",
     "test": "vitest run",
+    "test:bun": "(cd runtimes/bun && bun wiptest)",
     "test:deno": "deno test --allow-read --allow-net --allow-env --import-map=runtimes/deno/import_map.json runtimes/deno",
-    "test:edge-runtime": "npm test -- --environment edge-runtime",
-    "test:bun": "(cd runtimes/bun && bun wiptest)"
+    "test:edge-runtime": "npm test -- --environment edge-runtime"
   },
+  "browserslist": [
+    "> 0.2% and supports es6-module and supports es6-module-dynamic-import and not dead and not IE 11",
+    "maintained node versions"
+  ],
   "prettier": {
     "bracketSpacing": false,
     "printWidth": 100,
@@ -83,6 +83,7 @@
   },
   "dependencies": {
     "@sanity/eventsource": "^4.0.0",
+    "@types/node": "^18",
     "get-it": "^8.0.1",
     "make-error": "^1.3.6",
     "rxjs": "^7"
@@ -96,7 +97,6 @@
     "@rollup/plugin-node-resolve": "^15.0.1",
     "@sanity/pkg-utils": "^2.1.1",
     "@sanity/semantic-release-preset": "^2.0.5",
-    "@types/node": "^18.11.18",
     "@typescript-eslint/eslint-plugin": "^5.48.0",
     "@typescript-eslint/parser": "^5.48.0",
     "babel-plugin-add-module-exports": "^1.0.4",

package/src/SanityClient.ts

@@ -7,16 +7,8 @@ import * as dataMethods from './data/dataMethods'
 import {_listen} from './data/listen'
 import {ObservablePatch, Patch} from './data/patch'
 import {ObservableTransaction, Transaction} from './data/transaction'
-import {
-  BaseDatasetsClient,
-  DatasetsClient,
-  ObservableDatasetsClient,
-} from './datasets/DatasetsClient'
-import {
-  BaseProjectsClient,
-  ObservableProjectsClient,
-  ProjectsClient,
-} from './projects/ProjectsClient'
+import {DatasetsClient, ObservableDatasetsClient} from './datasets/DatasetsClient'
+import {ObservableProjectsClient, ProjectsClient} from './projects/ProjectsClient'
 import type {
   AllDocumentIdsMutationOptions,
   AllDocumentsMutationOptions,
@@ -40,16 +32,12 @@ import type {
   SingleMutationResult,
   UnfilteredResponseQueryOptions,
 } from './types'
-import {BaseUsersClient, ObservableUsersClient, UsersClient} from './users/UsersClient'
-import * as validators from './validators'
+import {ObservableUsersClient, UsersClient} from './users/UsersClient'
 
 export type {
   _listen,
   AssetsClient,
   AuthClient,
-  BaseDatasetsClient,
-  BaseProjectsClient,
-  BaseUsersClient,
   DatasetsClient,
   ObservableAssetsClient,
   ObservableAuthClient,
@@ -80,9 +68,9 @@ export class ObservableSanityClient {
 
     this.assets = new ObservableAssetsClient(this, this.#httpRequest)
     this.auth = new ObservableAuthClient(this, this.#httpRequest)
-    this.datasets = new ObservableDatasetsClient(this)
-    this.projects = new ObservableProjectsClient(this)
-    this.users = new ObservableUsersClient(this)
+    this.datasets = new ObservableDatasetsClient(this, this.#httpRequest)
+    this.projects = new ObservableProjectsClient(this, this.#httpRequest)
+    this.users = new ObservableUsersClient(this, this.#httpRequest)
   }
 
   /**
@@ -622,33 +610,6 @@ export class ObservableSanityClient {
   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 {
@@ -675,17 +636,17 @@ export class SanityClient {
   listen = _listen
 
   constructor(httpRequest: HttpRequest, config: ClientConfig) {
+    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.#httpRequest)
-    this.datasets = new DatasetsClient(this)
-    this.projects = new ProjectsClient(this)
-    this.users = new UsersClient(this)
-
-    this.observable = new ObservableSanityClient(httpRequest, this.config())
+    this.datasets = new DatasetsClient(this, this.#httpRequest)
+    this.projects = new ProjectsClient(this, this.#httpRequest)
+    this.users = new UsersClient(this, this.#httpRequest)
   }
 
   /**
@@ -1245,31 +1206,4 @@ export class SanityClient {
   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,6 +1,6 @@
 import {type Observable, lastValueFrom} from 'rxjs'
 
-import * as dataMethods from '../data/dataMethods'
+import {_request} from '../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import type {AuthProviderResponse, HttpRequest} from '../types'
 
@@ -15,15 +15,17 @@ export class ObservableAuthClient {
   /**
    * Fetch available login providers
    */
-  getLoginProviders<R = AuthProviderResponse>(): Observable<R> {
-    return dataMethods._request<R>(this.#client, this.#httpRequest, {uri: '/auth/providers'})
+  getLoginProviders(): Observable<AuthProviderResponse> {
+    return _request<AuthProviderResponse>(this.#client, this.#httpRequest, {
+      uri: '/auth/providers',
+    })
   }
 
   /**
    * Revoke the configured session/token
    */
-  logout<R = any>(): Observable<R> {
-    return dataMethods._request<R>(this.#client, this.#httpRequest, {
+  logout(): Observable<void> {
+    return _request<void>(this.#client, this.#httpRequest, {
       uri: '/auth/logout',
       method: 'POST',
     })
@@ -41,18 +43,20 @@ export class AuthClient {
   /**
    * Fetch available login providers
    */
-  getLoginProviders<R = AuthProviderResponse>(): Promise<R> {
+  getLoginProviders(): Promise<AuthProviderResponse> {
     return lastValueFrom(
-      dataMethods._request<R>(this.#client, this.#httpRequest, {uri: '/auth/providers'})
+      _request<AuthProviderResponse>(this.#client, this.#httpRequest, {
+        uri: '/auth/providers',
+      })
     )
   }
 
   /**
    * Revoke the configured session/token
    */
-  logout<R = any>(): Promise<R> {
+  logout(): Promise<void> {
     return lastValueFrom(
-      dataMethods._request<R>(this.#client, this.#httpRequest, {
+      _request<void>(this.#client, this.#httpRequest, {
         uri: '/auth/logout',
         method: 'POST',
       })

package/src/data/dataMethods.ts

@@ -79,7 +79,7 @@ export function _getDocument<R extends Record<string, any>>(
   id: string,
   opts: {tag?: string} = {}
 ): Observable<SanityDocument<R> | undefined> {
-  const options = {uri: client.getDataUrl('doc', id), json: true, tag: opts.tag}
+  const options = {uri: _getDataUrl(client, 'doc', id), json: true, tag: opts.tag}
   return _requestObservable<SanityDocument<R> | undefined>(client, httpRequest, options).pipe(
     filter(isResponse),
     map((event) => event.body.documents && event.body.documents[0])
@@ -93,7 +93,7 @@ export function _getDocuments<R extends Record<string, any>>(
   ids: string[],
   opts: {tag?: string} = {}
 ): Observable<(SanityDocument<R> | null)[]> {
-  const options = {uri: client.getDataUrl('doc', ids.join(',')), json: true, tag: opts.tag}
+  const options = {uri: _getDataUrl(client, 'doc', ids.join(',')), json: true, tag: opts.tag}
   return _requestObservable<(SanityDocument<R> | null)[]>(client, httpRequest, options).pipe(
     filter(isResponse),
     map((event: any) => {
@@ -210,7 +210,7 @@ export function _dataRequest(
   const returnFirst = options.returnFirst
   const {timeout, token, tag, headers} = options
 
-  const uri = client.getDataUrl(endpoint, stringQuery)
+  const uri = _getDataUrl(client, endpoint, stringQuery)
 
   const reqOptions = {
     method: useGet ? 'GET' : 'POST',
@@ -302,7 +302,7 @@ export function _requestObservable<R>(
   const reqOptions = getRequestOptions(
     config,
     Object.assign({}, options, {
-      url: client.getUrl(uri, useCdn),
+      url: _getUrl(client, uri, useCdn),
     })
   ) as RequestOptions
 
@@ -326,3 +326,28 @@ export function _request<R>(
 
   return observable
 }
+
+/**
+ * @internal
+ */
+export function _getDataUrl(
+  client: SanityClient | ObservableSanityClient,
+  operation: string,
+  path?: string
+): string {
+  const config = client.config()
+  const catalog = validators.hasDataset(config)
+  const baseUri = `/${operation}/${catalog}`
+  const uri = path ? `${baseUri}/${path}` : baseUri
+  return `/data${uri}`.replace(/\/($|\?)/, '$1')
+}
+
+function _getUrl(
+  client: SanityClient | ObservableSanityClient,
+  uri: string,
+  canUseCdn = false
+): string {
+  const {url, cdnUrl} = client.config()
+  const base = canUseCdn ? cdnUrl : url
+  return `${base}/${uri.replace(/^\//, '')}`
+}

package/src/data/listen.ts

@@ -1,10 +1,11 @@
 import polyfilledEventSource from '@sanity/eventsource'
 import {Observable} from 'rxjs'
 
-import type {ObservableSanityClient, SanityClient} from '../SanityClient'
+import type {SanityClient} from '../SanityClient'
 import type {ListenEvent, ListenOptions, MutationEvent, QueryParams} from '../types'
 import defaults from '../util/defaults'
 import pick from '../util/pick'
+import {_getDataUrl} from './dataMethods'
 import encodeQueryString from './encodeQueryString'
 
 // Limit is 16K for a _request_, eg including headers. Have to account for an
@@ -54,7 +55,7 @@ export function _listen<R extends Record<string, any> = Record<string, any>>(
 ): Observable<ListenEvent<R>>
 /** @internal */
 export function _listen<R extends Record<string, any> = Record<string, any>>(
-  this: SanityClient | ObservableSanityClient,
+  this: SanityClient,
   query: string,
   params?: QueryParams,
   opts: ListenOptions = {}
@@ -65,7 +66,7 @@ export function _listen<R extends Record<string, any> = Record<string, any>>(
   const listenOpts = pick(options, possibleOptions)
   const qs = encodeQueryString({query, params, options: {tag, ...listenOpts}})
 
-  const uri = `${url}${this.getDataUrl('listen', qs)}`
+  const uri = `${url}${_getDataUrl(this, 'listen', qs)}`
   if (uri.length > MAX_URL_LENGTH) {
     return new Observable((observer) => observer.error(new Error('Query too large for listener')))
   }

package/src/datasets/DatasetsClient.ts

@@ -1,11 +1,17 @@
-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
+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 +19,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 +29,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 +38,76 @@ 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})
+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/projects/ProjectsClient.ts

@@ -1,18 +1,22 @@
-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
+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 +24,36 @@ 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
+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}`})
+    )
   }
 }