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

package/src/assets/AssetsClient.ts

@@ -13,6 +13,7 @@ import type {
 } from '../types'
 import * as validators from '../validators'
 
+/** @internal */
 export class ObservableAssetsClient {
   #client: ObservableSanityClient
   #httpRequest: HttpRequest
@@ -24,9 +25,9 @@ export class ObservableAssetsClient {
   /**
    * Uploads a file 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
+   * @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',
@@ -37,9 +38,9 @@ export class ObservableAssetsClient {
   /**
    * Uploads 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
+   * @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: 'image',
@@ -55,6 +56,7 @@ export class ObservableAssetsClient {
   }
 }
 
+/** @internal */
 export class AssetsClient {
   #client: SanityClient
   #httpRequest: HttpRequest
@@ -66,9 +68,9 @@ export class AssetsClient {
   /**
    * Uploads a file 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
+   * @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',
@@ -78,9 +80,9 @@ export class AssetsClient {
   /**
    * Uploads 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
+   * @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: 'image',

package/src/auth/AuthClient.ts

@@ -1,9 +1,10 @@
 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'
 
+/** @internal */
 export class ObservableAuthClient {
   #client: ObservableSanityClient
   #httpRequest: HttpRequest
@@ -15,21 +16,24 @@ 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',
     })
   }
 }
 
+/** @internal */
 export class AuthClient {
   #client: SanityClient
   #httpRequest: HttpRequest
@@ -41,18 +45,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/config.ts

@@ -4,7 +4,7 @@ import * as validate from './validators'
 import * as warnings from './warnings'
 
 const defaultCdnHost = 'apicdn.sanity.io'
-const defaultConfig = {
+export const defaultConfig = {
   apiHost: 'https://api.sanity.io',
   apiVersion: '1',
   useProjectHostname: true,
@@ -58,7 +58,7 @@ export const initConfig = (
   }
 
   if (projectBased) {
-    validate.projectId(newConfig.projectId)
+    validate.projectId(newConfig.projectId!)
   }
 
   if (newConfig.dataset) {

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,31 @@ 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')
+}
+
+/**
+ * @internal
+ */
+export 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
@@ -28,9 +29,9 @@ const defaultOptions = {
 /**
  * Set up a listener that will be notified when mutations occur on documents matching the provided query/filter.
  *
- * @param query GROQ-filter to listen to changes for
- * @param params Optional query parameters
- * @param options Listener options
+ * @param query - GROQ-filter to listen to changes for
+ * @param params - Optional query parameters
+ * @param options - Listener options
  * @internal
  */
 export function _listen<R extends Record<string, any> = Record<string, any>>(
@@ -41,9 +42,9 @@ export function _listen<R extends Record<string, any> = Record<string, any>>(
 /**
  * Set up a listener that will be notified when mutations occur on documents matching the provided query/filter.
  *
- * @param query GROQ-filter to listen to changes for
- * @param params Optional query parameters
- * @param options Listener options
+ * @param query - GROQ-filter to listen to changes for
+ * @param params - Optional query parameters
+ * @param options - Listener options
  * @internal
  */
 export function _listen<R extends Record<string, any> = Record<string, any>>(
@@ -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/data/patch.ts

@@ -18,6 +18,7 @@ import type {
 import getSelection from '../util/getSelection'
 import {validateInsert, validateObject} from '../validators'
 
+/** @internal */
 export class BasePatch {
   protected selection: PatchSelection
   protected operations: PatchOperations
@@ -30,8 +31,8 @@ export class BasePatch {
    * DEPRECATED: Don't use.
    * The operation is added to the current patch, ready to be commited by `commit()`
    *
-   * @deprecated
-   * @param attrs Attributes to replace
+   * @deprecated - Don't use.
+   * @param attrs - Attributes to replace
    */
   replace(attrs: AttributeSet): this {
     validateObject('replace', attrs)
@@ -42,7 +43,7 @@ export class BasePatch {
    * 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()`
    *
-   * @param attrs Attributes to set. To set a deep attribute, use JSONMatch, eg: {"nested.prop": "value"}
+   * @param attrs - Attributes to set. To set a deep attribute, use JSONMatch, eg: \{"nested.prop": "value"\}
    */
   set(attrs: AttributeSet): this {
     return this._assign('set', attrs)
@@ -52,7 +53,7 @@ export class BasePatch {
    * Sets the given attributes to the document if they are not currently set. Does NOT merge objects.
    * The operation is added to the current patch, ready to be commited by `commit()`
    *
-   * @param attrs Attributes to set. To set a deep attribute, use JSONMatch, eg: {"nested.prop": "value"}
+   * @param attrs - Attributes to set. To set a deep attribute, use JSONMatch, eg: \{"nested.prop": "value"\}
    */
   setIfMissing(attrs: AttributeSet): this {
     return this._assign('setIfMissing', attrs)
@@ -62,7 +63,7 @@ export class BasePatch {
    * Performs a "diff-match-patch" operation on the string attributes provided.
    * The operation is added to the current patch, ready to be commited by `commit()`
    *
-   * @param attrs Attributes to perform operation on. To set a deep attribute, use JSONMatch, eg: {"nested.prop": "dmp"}
+   * @param attrs - Attributes to perform operation on. To set a deep attribute, use JSONMatch, eg: \{"nested.prop": "dmp"\}
    */
   diffMatchPatch(attrs: AttributeSet): this {
     validateObject('diffMatchPatch', attrs)
@@ -73,7 +74,7 @@ export class BasePatch {
    * Unsets the attribute paths provided.
    * The operation is added to the current patch, ready to be commited by `commit()`
    *
-   * @param attrs Attribute paths to unset.
+   * @param attrs - Attribute paths to unset.
    */
   unset(attrs: string[]): this {
     if (!Array.isArray(attrs)) {
@@ -87,7 +88,7 @@ export class BasePatch {
   /**
    * Increment a numeric value. Each entry in the argument is either an attribute or a JSON path. The value may be a positive or negative integer or floating-point value. The operation will fail if target value is not a numeric value, or doesn't exist.
    *
-   * @param attrs Object of attribute paths to increment, values representing the number to increment by.
+   * @param attrs - Object of attribute paths to increment, values representing the number to increment by.
    */
   inc(attrs: {[key: string]: number}): this {
     return this._assign('inc', attrs)
@@ -96,7 +97,7 @@ export class BasePatch {
   /**
    * Decrement a numeric value. Each entry in the argument is either an attribute or a JSON path. The value may be a positive or negative integer or floating-point value. The operation will fail if target value is not a numeric value, or doesn't exist.
    *
-   * @param attrs Object of attribute paths to decrement, values representing the number to decrement by.
+   * @param attrs - Object of attribute paths to decrement, values representing the number to decrement by.
    */
   dec(attrs: {[key: string]: number}): this {
     return this._assign('dec', attrs)
@@ -105,9 +106,9 @@ export class BasePatch {
   /**
    * Provides methods for modifying arrays, by inserting, appending and replacing elements via a JSONPath expression.
    *
-   * @param at Location to insert at, relative to the given selector, or 'replace' the matched path
-   * @param selector JSONPath expression, eg `comments[-1]` or `blocks[_key=="abc123"]`
-   * @param items Array of items to insert/replace
+   * @param at - Location to insert at, relative to the given selector, or 'replace' the matched path
+   * @param selector - JSONPath expression, eg `comments[-1]` or `blocks[_key=="abc123"]`
+   * @param items - Array of items to insert/replace
    */
   insert(at: 'before' | 'after' | 'replace', selector: string, items: any[]): this {
     validateInsert(at, selector, items)
@@ -117,8 +118,8 @@ export class BasePatch {
   /**
    * Append the given items to the array at the given JSONPath
    *
-   * @param selector Attribute/path to append to, eg `comments` or `person.hobbies`
-   * @param items Array of items to append to the array
+   * @param selector - Attribute/path to append to, eg `comments` or `person.hobbies`
+   * @param items - Array of items to append to the array
    */
   append(selector: string, items: any[]): this {
     return this.insert('after', `${selector}[-1]`, items)
@@ -127,8 +128,8 @@ export class BasePatch {
   /**
    * Prepend the given items to the array at the given JSONPath
    *
-   * @param selector Attribute/path to prepend to, eg `comments` or `person.hobbies`
-   * @param items Array of items to prepend to the array
+   * @param selector - Attribute/path to prepend to, eg `comments` or `person.hobbies`
+   * @param items - Array of items to prepend to the array
    */
   prepend(selector: string, items: any[]): this {
     return this.insert('before', `${selector}[0]`, items)
@@ -137,12 +138,12 @@ export class BasePatch {
   /**
    * Change the contents of an array by removing existing elements and/or adding new elements.
    *
-   * @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 any elements, splice() will only remove elements from the array.
+   * @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 any elements, splice() will only remove elements from the array.
    */
-  splice(selector: string, start: number, deleteCount: number, items: any[]): this {
+  splice(selector: string, start: number, deleteCount?: number, items?: any[]): this {
     // Negative indexes doesn't mean the same in Sanity as they do in JS;
     // -1 means "actually at the end of the array", which allows inserting
     // at the end of the array without knowing its length. We therefore have
@@ -159,7 +160,7 @@ export class BasePatch {
   /**
    * Adds a revision clause, preventing the document from being patched if the `_rev` property does not match the given value
    *
-   * @param rev Revision to lock the patch to
+   * @param rev - Revision to lock the patch to
    */
   ifRevisionId(rev: string): this {
     this.operations.ifRevisionID = rev
@@ -201,6 +202,7 @@ export class BasePatch {
   }
 }
 
+/** @public */
 export class ObservablePatch extends BasePatch {
   #client?: ObservableSanityClient
 
@@ -223,7 +225,7 @@ export class ObservablePatch extends BasePatch {
   /**
    * Commit the patch, returning an observable that produces the first patched document
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit<R extends Record<string, any> = Record<string, any>>(
     options: FirstDocumentMutationOptions
@@ -231,7 +233,7 @@ export class ObservablePatch extends BasePatch {
   /**
    * Commit the patch, returning an observable that produces an array of the mutated documents
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit<R extends Record<string, any> = Record<string, any>>(
     options: AllDocumentsMutationOptions
@@ -239,19 +241,19 @@ export class ObservablePatch extends BasePatch {
   /**
    * Commit the patch, returning an observable that produces a mutation result object
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit(options: FirstDocumentIdMutationOptions): Observable<SingleMutationResult>
   /**
    * Commit the patch, returning an observable that produces a mutation result object
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit(options: AllDocumentIdsMutationOptions): Observable<MultipleMutationResult>
   /**
    * Commit the patch, returning an observable that produces the first patched document
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit<R extends Record<string, any> = Record<string, any>>(
     options?: BaseMutationOptions
@@ -279,6 +281,7 @@ export class ObservablePatch extends BasePatch {
   }
 }
 
+/** @public */
 export class Patch extends BasePatch {
   #client?: SanityClient
   constructor(selection: PatchSelection, operations?: PatchOperations, client?: SanityClient) {
@@ -296,7 +299,7 @@ export class Patch extends BasePatch {
   /**
    * Commit the patch, returning a promise that resolves to the first patched document
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit<R extends Record<string, any> = Record<string, any>>(
     options: FirstDocumentMutationOptions
@@ -304,7 +307,7 @@ export class Patch extends BasePatch {
   /**
    * Commit the patch, returning a promise that resolves to an array of the mutated documents
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit<R extends Record<string, any> = Record<string, any>>(
     options: AllDocumentsMutationOptions
@@ -312,19 +315,19 @@ export class Patch extends BasePatch {
   /**
    * Commit the patch, returning a promise that resolves to a mutation result object
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit(options: FirstDocumentIdMutationOptions): Promise<SingleMutationResult>
   /**
    * Commit the patch, returning a promise that resolves to a mutation result object
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit(options: AllDocumentIdsMutationOptions): Promise<MultipleMutationResult>
   /**
    * Commit the patch, returning a promise that resolves to the first patched document
    *
-   * @param options Options for the mutation operation
+   * @param options - Options for the mutation operation
    */
   commit<R extends Record<string, any> = Record<string, any>>(
     options?: BaseMutationOptions

package/src/data/transaction.ts

@@ -18,11 +18,14 @@ import type {
 import * as validators from '../validators'
 import {ObservablePatch, Patch} from './patch'
 
+/** @public */
 export type PatchBuilder = (patch: Patch) => Patch
+/** @public */
 export type ObservablePatchBuilder = (patch: ObservablePatch) => ObservablePatch
 
 const defaultMutateOptions = {returnDocuments: false}
 
+/** @internal */
 export class BaseTransaction {
   protected operations: Mutation[]
   protected trxId?: string
@@ -129,6 +132,7 @@ export class BaseTransaction {
   }
 }
 
+/** @public */
 export class Transaction extends BaseTransaction {
   #client?: SanityClient
   constructor(operations?: Mutation[], client?: SanityClient, transactionId?: string) {
@@ -238,6 +242,7 @@ export class Transaction extends BaseTransaction {
   }
 }
 
+/** @public */
 export class ObservableTransaction extends BaseTransaction {
   #client?: ObservableSanityClient
   constructor(operations?: Mutation[], client?: ObservableSanityClient, transactionId?: string) {