@sanity/client 5.0.0-esm.8 → 5.0.0

package/src/assets/AssetsClient.ts

@@ -1,9 +1,10 @@
-import {type Observable, lastValueFrom} from 'rxjs'
+import {lastValueFrom, type Observable} from 'rxjs'
 import {filter, map} from 'rxjs/operators'
 
 import {_requestObservable} from '../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import type {
+  FIXME,
   HttpRequest,
   HttpRequestEvent,
   ResponseEvent,
@@ -25,7 +26,7 @@ export class ObservableAssetsClient {
   /**
    * Uploads a file asset to the configured dataset
    *
-   * @param assetType - Asset type (file/image)
+   * @param assetType - Asset type (file)
    * @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
    */
@@ -38,7 +39,7 @@ export class ObservableAssetsClient {
   /**
    * Uploads an image asset to the configured dataset
    *
-   * @param assetType - Asset type (file/image)
+   * @param assetType - Asset type (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
    */
@@ -47,6 +48,18 @@ export class ObservableAssetsClient {
     body: File | Blob | Buffer | NodeJS.ReadableStream,
     options?: UploadClientConfig
   ): Observable<HttpRequestEvent<{document: SanityImageAssetDocument}>>
+  /**
+   * Uploads a file or 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
+   */
+  upload(
+    assetType: 'file' | 'image',
+    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    options?: UploadClientConfig
+  ): Observable<HttpRequestEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>>
   upload(
     assetType: 'file' | 'image',
     body: File | Blob | Buffer | NodeJS.ReadableStream,
@@ -68,7 +81,7 @@ export class AssetsClient {
   /**
    * Uploads a file asset to the configured dataset
    *
-   * @param assetType - Asset type (file/image)
+   * @param assetType - Asset type (file)
    * @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
    */
@@ -80,7 +93,7 @@ export class AssetsClient {
   /**
    * Uploads an image asset to the configured dataset
    *
-   * @param assetType - Asset type (file/image)
+   * @param assetType - Asset type (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
    */
@@ -89,6 +102,18 @@ export class AssetsClient {
     body: File | Blob | Buffer | NodeJS.ReadableStream,
     options?: UploadClientConfig
   ): Promise<SanityImageAssetDocument>
+  /**
+   * Uploads a file or 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
+   */
+  upload(
+    assetType: 'file' | 'image',
+    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    options?: UploadClientConfig
+  ): Promise<SanityAssetDocument | SanityImageAssetDocument>
   upload(
     assetType: 'file' | 'image',
     body: File | Blob | Buffer | NodeJS.ReadableStream,
@@ -97,7 +122,7 @@ export class AssetsClient {
     const observable = _upload(this.#client, this.#httpRequest, assetType, body, options)
     return lastValueFrom(
       observable.pipe(
-        filter((event: any) => event.type === 'response'),
+        filter((event: FIXME) => event.type === 'response'),
         map(
           (event) =>
             (event as ResponseEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>)
@@ -127,7 +152,7 @@ function _upload(
   const assetEndpoint = assetType === 'image' ? 'images' : 'files'
   const options = optionsFromFile(opts, body)
   const {tag, label, title, description, creditLine, filename, source} = options
-  const query: any = {
+  const query: FIXME = {
     label,
     title,
     description,
@@ -151,7 +176,7 @@ function _upload(
   })
 }
 
-function optionsFromFile(opts: Record<string, any>, file: any) {
+function optionsFromFile(opts: Record<string, FIXME>, file: FIXME) {
   if (typeof window === 'undefined' || !(file instanceof window.File)) {
     return opts
   }

package/src/config.ts

@@ -58,6 +58,7 @@ export const initConfig = (
   }
 
   if (projectBased) {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- the nullability here is wrong, as line 48 throws an error if it's undefined
     validate.projectId(newConfig.projectId!)
   }
 

package/src/data/dataMethods.ts

@@ -10,6 +10,7 @@ import type {
   FilteredResponseQueryOptions,
   FirstDocumentIdMutationOptions,
   FirstDocumentMutationOptions,
+  FIXME,
   HttpRequest,
   HttpRequestEvent,
   IdentifiedSanityDocumentStub,
@@ -31,7 +32,7 @@ import encodeQueryString from './encodeQueryString'
 import {ObservablePatch, Patch} from './patch'
 import {ObservableTransaction, Transaction} from './transaction'
 
-const excludeFalsey = (param: any, defValue: any) => {
+const excludeFalsey = (param: FIXME, defValue: FIXME) => {
   const value = typeof param === 'undefined' ? defValue : param
   return param === false ? undefined : value
 }
@@ -47,10 +48,10 @@ const getMutationQuery = (options: BaseMutationOptions = {}) => {
   }
 }
 
-const isResponse = (event: any) => event.type === 'response'
-const getBody = (event: any) => event.body
+const isResponse = (event: FIXME) => event.type === 'response'
+const getBody = (event: FIXME) => event.body
 
-const indexBy = (docs: any[], attr: any) =>
+const indexBy = (docs: FIXME[], attr: FIXME) =>
   docs.reduce((indexed, doc) => {
     indexed[attr(doc)] = doc
     return indexed
@@ -59,21 +60,21 @@ const indexBy = (docs: any[], attr: any) =>
 const getQuerySizeLimit = 11264
 
 /** @internal */
-export function _fetch<R>(
+export function _fetch<R, Q extends QueryParams>(
   client: ObservableSanityClient | SanityClient,
   httpRequest: HttpRequest,
   query: string,
-  params?: QueryParams,
+  params?: Q,
   options: FilteredResponseQueryOptions | UnfilteredResponseQueryOptions = {}
 ): Observable<RawQueryResponse<R> | R> {
   const mapResponse =
-    options.filterResponse === false ? (res: any) => res : (res: any) => res.result
+    options.filterResponse === false ? (res: FIXME) => res : (res: FIXME) => res.result
 
   return _dataRequest(client, httpRequest, 'query', {query, params}, options).pipe(map(mapResponse))
 }
 
 /** @internal */
-export function _getDocument<R extends Record<string, any>>(
+export function _getDocument<R extends Record<string, FIXME>>(
   client: ObservableSanityClient | SanityClient,
   httpRequest: HttpRequest,
   id: string,
@@ -87,7 +88,7 @@ export function _getDocument<R extends Record<string, any>>(
 }
 
 /** @internal */
-export function _getDocuments<R extends Record<string, any>>(
+export function _getDocuments<R extends Record<string, FIXME>>(
   client: ObservableSanityClient | SanityClient,
   httpRequest: HttpRequest,
   ids: string[],
@@ -96,15 +97,15 @@ export function _getDocuments<R extends Record<string, any>>(
   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) => {
-      const indexed = indexBy(event.body.documents || [], (doc: any) => doc._id)
+    map((event: FIXME) => {
+      const indexed = indexBy(event.body.documents || [], (doc: FIXME) => doc._id)
       return ids.map((id) => indexed[id] || null)
     })
   )
 }
 
 /** @internal */
-export function _createIfNotExists<R extends Record<string, any>>(
+export function _createIfNotExists<R extends Record<string, FIXME>>(
   client: ObservableSanityClient | SanityClient,
   httpRequest: HttpRequest,
   doc: IdentifiedSanityDocumentStub<R>,
@@ -122,7 +123,7 @@ export function _createIfNotExists<R extends Record<string, any>>(
 }
 
 /** @internal */
-export function _createOrReplace<R extends Record<string, any>>(
+export function _createOrReplace<R extends Record<string, FIXME>>(
   client: ObservableSanityClient | SanityClient,
   httpRequest: HttpRequest,
   doc: IdentifiedSanityDocumentStub<R>,
@@ -140,7 +141,7 @@ export function _createOrReplace<R extends Record<string, any>>(
 }
 
 /** @internal */
-export function _delete<R extends Record<string, any>>(
+export function _delete<R extends Record<string, FIXME>>(
   client: ObservableSanityClient | SanityClient,
   httpRequest: HttpRequest,
   selection: string | MutationSelection,
@@ -163,7 +164,7 @@ export function _delete<R extends Record<string, any>>(
 }
 
 /** @internal */
-export function _mutate<R extends Record<string, any>>(
+export function _mutate<R extends Record<string, FIXME>>(
   client: SanityClient | ObservableSanityClient,
   httpRequest: HttpRequest,
   mutations: Mutation<R>[] | Patch | ObservablePatch | Transaction | ObservableTransaction,
@@ -185,7 +186,7 @@ export function _mutate<R extends Record<string, any>>(
       : mutations
 
   const muts = Array.isArray(mut) ? mut : [mut]
-  const transactionId = options && (options as any).transactionId
+  const transactionId = options && (options as FIXME).transactionId
   return _dataRequest(client, httpRequest, 'mutate', {mutations: muts, transactionId}, options)
 }
 
@@ -196,9 +197,9 @@ export function _dataRequest(
   client: SanityClient | ObservableSanityClient,
   httpRequest: HttpRequest,
   endpoint: string,
-  body: any,
-  options: any = {}
-): any {
+  body: FIXME,
+  options: FIXME = {}
+): FIXME {
   const isMutation = endpoint === 'mutate'
   const isQuery = endpoint === 'query'
 
@@ -238,12 +239,12 @@ export function _dataRequest(
       if (options.returnDocuments) {
         return returnFirst
           ? results[0] && results[0].document
-          : results.map((mut: any) => mut.document)
+          : results.map((mut: FIXME) => mut.document)
       }
 
       // Return a reduced subset
       const key = returnFirst ? 'documentId' : 'documentIds'
-      const ids = returnFirst ? results[0] && results[0].id : results.map((mut: any) => mut.id)
+      const ids = returnFirst ? results[0] && results[0].id : results.map((mut: FIXME) => mut.id)
       return {
         transactionId: res.transactionId,
         results: results,
@@ -256,12 +257,12 @@ export function _dataRequest(
 /**
  * @internal
  */
-export function _create<R extends Record<string, any>>(
+export function _create<R extends Record<string, FIXME>>(
   client: SanityClient | ObservableSanityClient,
   httpRequest: HttpRequest,
-  doc: any,
-  op: any,
-  options: any = {}
+  doc: FIXME,
+  op: FIXME,
+  options: FIXME = {}
 ): Observable<
   SanityDocument<R> | SanityDocument<R>[] | SingleMutationResult | MultipleMutationResult
 > {
@@ -307,6 +308,7 @@ export function _requestObservable<R>(
   ) as RequestOptions
 
   return new Observable<HttpRequestEvent<R>>((subscriber) =>
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- the typings thinks it's optional because it's not required to specify it when calling createClient, but it's always defined in practice since SanityClient provides a default
     httpRequest(reqOptions, config.requester!).subscribe(subscriber)
   )
 }
@@ -317,11 +319,11 @@ export function _requestObservable<R>(
 export function _request<R>(
   client: SanityClient | ObservableSanityClient,
   httpRequest: HttpRequest,
-  options: any
+  options: FIXME
 ): Observable<R> {
   const observable = _requestObservable<R>(client, httpRequest, options).pipe(
-    filter((event: any) => event.type === 'response'),
-    map((event: any) => event.body)
+    filter((event: FIXME) => event.type === 'response'),
+    map((event: FIXME) => event.body)
   )
 
   return observable

package/src/data/encodeQueryString.ts

@@ -1,28 +1,29 @@
-import type {QueryParams} from '../types'
-
-const enc = encodeURIComponent
+import type {FIXME, QueryParams} from '../types'
 
 export default ({
   query,
-  params = {} as any,
-  options = {} as any,
+  params = {},
+  options = {},
 }: {
   query: string
   params?: QueryParams
-  options?: any
+  options?: FIXME
 }) => {
+  const searchParams = new URLSearchParams()
   // We generally want tag at the start of the query string
   const {tag, ...opts} = options
-  const q = `query=${enc(query)}`
-  const base = tag ? `?tag=${enc(tag)}&${q}` : `?${q}`
+  if (tag) searchParams.set('tag', tag)
+  searchParams.set('query', query)
 
-  const qString = Object.keys(params).reduce(
-    (qs, param) => `${qs}&${enc(`$${param}`)}=${enc(JSON.stringify(params[param]))}`,
-    base
-  )
+  // Iterate params, the keys are prefixed with `$` and their values JSON stringified
+  for (const [key, value] of Object.entries(params)) {
+    searchParams.set(`$${key}`, JSON.stringify(value))
+  }
+  // Options are passed as-is
+  for (const [key, value] of Object.entries(opts)) {
+    // Skip falsy values
+    if (value) searchParams.set(key, `${value}`)
+  }
 
-  return Object.keys(opts).reduce((qs, option) => {
-    // Only include the option if it is truthy
-    return options[option] ? `${qs}&${enc(option)}=${enc(options[option])}` : qs
-  }, qString)
+  return `?${searchParams}`
 }

package/src/data/listen.ts

@@ -1,8 +1,8 @@
 import polyfilledEventSource from '@sanity/eventsource'
 import {Observable} from 'rxjs'
 
-import type {SanityClient} from '../SanityClient'
-import type {ListenEvent, ListenOptions, MutationEvent, QueryParams} from '../types'
+import type {ObservableSanityClient, SanityClient} from '../SanityClient'
+import type {FIXME, ListenEvent, ListenOptions, MutationEvent, QueryParams} from '../types'
 import defaults from '../util/defaults'
 import pick from '../util/pick'
 import {_getDataUrl} from './dataMethods'
@@ -34,8 +34,8 @@ const defaultOptions = {
  * @param options - Listener options
  * @internal
  */
-export function _listen<R extends Record<string, any> = Record<string, any>>(
-  this: SanityClient,
+export function _listen<R extends Record<string, FIXME> = Record<string, FIXME>>(
+  this: SanityClient | ObservableSanityClient,
   query: string,
   params?: QueryParams
 ): Observable<MutationEvent<R>>
@@ -47,15 +47,15 @@ export function _listen<R extends Record<string, any> = Record<string, any>>(
  * @param options - Listener options
  * @internal
  */
-export function _listen<R extends Record<string, any> = Record<string, any>>(
-  this: SanityClient,
+export function _listen<R extends Record<string, FIXME> = Record<string, FIXME>>(
+  this: SanityClient | ObservableSanityClient,
   query: string,
   params?: QueryParams,
   options?: ListenOptions
 ): Observable<ListenEvent<R>>
 /** @internal */
-export function _listen<R extends Record<string, any> = Record<string, any>>(
-  this: SanityClient,
+export function _listen<R extends Record<string, FIXME> = Record<string, FIXME>>(
+  this: SanityClient | ObservableSanityClient,
   query: string,
   params?: QueryParams,
   opts: ListenOptions = {}
@@ -114,11 +114,11 @@ export function _listen<R extends Record<string, any> = Record<string, any>>(
       }
     }
 
-    function onChannelError(err: any) {
+    function onChannelError(err: FIXME) {
       observer.error(cooerceError(err))
     }
 
-    function onMessage(evt: any) {
+    function onMessage(evt: FIXME) {
       const event = parseEvent(evt)
       return event instanceof Error ? observer.error(event) : observer.next(event)
     }
@@ -165,7 +165,7 @@ export function _listen<R extends Record<string, any> = Record<string, any>>(
   })
 }
 
-function parseEvent(event: any) {
+function parseEvent(event: FIXME) {
   try {
     const data = (event.data && JSON.parse(event.data)) || {}
     return Object.assign({type: event.type}, data)
@@ -174,7 +174,7 @@ function parseEvent(event: any) {
   }
 }
 
-function cooerceError(err: any) {
+function cooerceError(err: FIXME) {
   if (err instanceof Error) {
     return err
   }
@@ -183,7 +183,7 @@ function cooerceError(err: any) {
   return evt instanceof Error ? evt : new Error(extractErrorMessage(evt))
 }
 
-function extractErrorMessage(err: any) {
+function extractErrorMessage(err: FIXME) {
   if (!err.error) {
     return err.message || 'Unknown listener error'
   }

package/src/data/patch.ts

@@ -8,6 +8,7 @@ import type {
   BaseMutationOptions,
   FirstDocumentIdMutationOptions,
   FirstDocumentMutationOptions,
+  FIXME,
   MultipleMutationResult,
   PatchMutationOperation,
   PatchOperations,
@@ -27,18 +28,6 @@ export class BasePatch {
     this.operations = operations
   }
 
-  /**
-   * DEPRECATED: Don't use.
-   * The operation is added to the current patch, ready to be commited by `commit()`
-   *
-   * @deprecated - Don't use.
-   * @param attrs - Attributes to replace
-   */
-  replace(attrs: AttributeSet): this {
-    validateObject('replace', attrs)
-    return this._set('set', {$: attrs})
-  }
-
   /**
    * 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()`
@@ -110,7 +99,7 @@ export class BasePatch {
    * @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 {
+  insert(at: 'before' | 'after' | 'replace', selector: string, items: FIXME[]): this {
     validateInsert(at, selector, items)
     return this._assign('insert', {[at]: selector, items})
   }
@@ -121,7 +110,7 @@ export class BasePatch {
    * @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 {
+  append(selector: string, items: FIXME[]): this {
     return this.insert('after', `${selector}[-1]`, items)
   }
 
@@ -131,7 +120,7 @@ export class BasePatch {
    * @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 {
+  prepend(selector: string, items: FIXME[]): this {
     return this.insert('before', `${selector}[0]`, items)
   }
 
@@ -143,7 +132,7 @@ export class BasePatch {
    * @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?: FIXME[]): 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
@@ -189,7 +178,7 @@ export class BasePatch {
     return this
   }
 
-  protected _assign(op: keyof PatchOperations, props: any, merge = true): this {
+  protected _assign(op: keyof PatchOperations, props: FIXME, merge = true): this {
     validateObject(op, props)
     this.operations = Object.assign({}, this.operations, {
       [op]: Object.assign({}, (merge && this.operations[op]) || {}, props),
@@ -197,7 +186,7 @@ export class BasePatch {
     return this
   }
 
-  protected _set(op: keyof PatchOperations, props: any): this {
+  protected _set(op: keyof PatchOperations, props: FIXME): this {
     return this._assign(op, props, false)
   }
 }
@@ -227,7 +216,7 @@ export class ObservablePatch extends BasePatch {
    *
    * @param options - Options for the mutation operation
    */
-  commit<R extends Record<string, any> = Record<string, any>>(
+  commit<R extends Record<string, FIXME> = Record<string, FIXME>>(
     options: FirstDocumentMutationOptions
   ): Observable<SanityDocument<R>>
   /**
@@ -235,7 +224,7 @@ export class ObservablePatch extends BasePatch {
    *
    * @param options - Options for the mutation operation
    */
-  commit<R extends Record<string, any> = Record<string, any>>(
+  commit<R extends Record<string, FIXME> = Record<string, FIXME>>(
     options: AllDocumentsMutationOptions
   ): Observable<SanityDocument<R>[]>
   /**
@@ -255,10 +244,10 @@ export class ObservablePatch extends BasePatch {
    *
    * @param options - Options for the mutation operation
    */
-  commit<R extends Record<string, any> = Record<string, any>>(
+  commit<R extends Record<string, FIXME> = Record<string, FIXME>>(
     options?: BaseMutationOptions
   ): Observable<SanityDocument<R>>
-  commit<R extends Record<string, any> = Record<string, any>>(
+  commit<R extends Record<string, FIXME> = Record<string, FIXME>>(
     options?:
       | FirstDocumentMutationOptions
       | AllDocumentsMutationOptions
@@ -277,7 +266,7 @@ export class ObservablePatch extends BasePatch {
 
     const returnFirst = typeof this.selection === 'string'
     const opts = Object.assign({returnFirst, returnDocuments: true}, options)
-    return this.#client.mutate<R>({patch: this.serialize()} as any, opts)
+    return this.#client.mutate<R>({patch: this.serialize()} as FIXME, opts)
   }
 }
 
@@ -301,7 +290,7 @@ export class Patch extends BasePatch {
    *
    * @param options - Options for the mutation operation
    */
-  commit<R extends Record<string, any> = Record<string, any>>(
+  commit<R extends Record<string, FIXME> = Record<string, FIXME>>(
     options: FirstDocumentMutationOptions
   ): Promise<SanityDocument<R>>
   /**
@@ -309,7 +298,7 @@ export class Patch extends BasePatch {
    *
    * @param options - Options for the mutation operation
    */
-  commit<R extends Record<string, any> = Record<string, any>>(
+  commit<R extends Record<string, FIXME> = Record<string, FIXME>>(
     options: AllDocumentsMutationOptions
   ): Promise<SanityDocument<R>[]>
   /**
@@ -329,10 +318,10 @@ export class Patch extends BasePatch {
    *
    * @param options - Options for the mutation operation
    */
-  commit<R extends Record<string, any> = Record<string, any>>(
+  commit<R extends Record<string, FIXME> = Record<string, FIXME>>(
     options?: BaseMutationOptions
   ): Promise<SanityDocument<R>>
-  commit<R extends Record<string, any> = Record<string, any>>(
+  commit<R extends Record<string, FIXME> = Record<string, FIXME>>(
     options?:
       | FirstDocumentMutationOptions
       | AllDocumentsMutationOptions
@@ -351,6 +340,6 @@ export class Patch extends BasePatch {
 
     const returnFirst = typeof this.selection === 'string'
     const opts = Object.assign({returnFirst, returnDocuments: true}, options)
-    return this.#client.mutate<R>({patch: this.serialize()} as any, opts)
+    return this.#client.mutate<R>({patch: this.serialize()} as FIXME, opts)
   }
 }