@sanity/client 5.0.0-esm.13 → 5.0.0-esm.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "5.0.0-esm.13",
+  "version": "5.0.0-esm.15",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -94,8 +94,8 @@
     "rxjs": "^7"
   },
   "devDependencies": {
-    "@edge-runtime/types": "^2.0.2",
-    "@edge-runtime/vm": "^2.0.2",
+    "@edge-runtime/types": "^2.0.3",
+    "@edge-runtime/vm": "^2.0.3",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
     "@sanity/pkg-utils": "^2.2.1",
@@ -113,7 +113,7 @@
     "nock": "^13.3.0",
     "prettier": "^2.8.3",
     "prettier-plugin-packagejson": "^2.4.0",
-    "rimraf": "^4.1.0",
+    "rimraf": "^4.1.1",
     "rollup": "^3.10.0",
     "sse-channel": "^4.0.0",
     "terser": "^5.16.1",
@@ -122,6 +122,6 @@
     "vitest-github-actions-reporter": "^0.9.0"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=14.18"
   }
 }

package/src/SanityClient.ts

@@ -1,7 +1,6 @@
 import {lastValueFrom, Observable} from 'rxjs'
 
 import {AssetsClient, ObservableAssetsClient} from './assets/AssetsClient'
-import {AuthClient, ObservableAuthClient} from './auth/AuthClient'
 import {defaultConfig, initConfig} from './config'
 import * as dataMethods from './data/dataMethods'
 import {_listen} from './data/listen'
@@ -39,10 +38,8 @@ import {ObservableUsersClient, UsersClient} from './users/UsersClient'
 export type {
   _listen,
   AssetsClient,
-  AuthClient,
   DatasetsClient,
   ObservableAssetsClient,
-  ObservableAuthClient,
   ObservableDatasetsClient,
   ObservableProjectsClient,
   ObservableUsersClient,
@@ -53,7 +50,6 @@ export type {
 /** @public */
 export class ObservableSanityClient {
   assets: ObservableAssetsClient
-  auth: ObservableAuthClient
   datasets: ObservableDatasetsClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
@@ -64,13 +60,17 @@ export class ObservableSanityClient {
   #clientConfig: InitializedClientConfig
   #httpRequest: HttpRequest
 
+  /**
+   * Instance properties
+   */
+  listen = _listen
+
   constructor(httpRequest: HttpRequest, config: ClientConfig = defaultConfig) {
     this.config(config)
 
     this.#httpRequest = httpRequest
 
     this.assets = new ObservableAssetsClient(this, this.#httpRequest)
-    this.auth = new ObservableAuthClient(this, this.#httpRequest)
     this.datasets = new ObservableDatasetsClient(this, this.#httpRequest)
     this.projects = new ObservableProjectsClient(this, this.#httpRequest)
     this.users = new ObservableUsersClient(this, this.#httpRequest)
@@ -127,7 +127,7 @@ export class ObservableSanityClient {
    * @param query - GROQ-query to perform
    * @param params - Query parameters
    */
-  fetch<R = FIXME>(query: string, params: QueryParams): Observable<R>
+  fetch<R = FIXME, Q = QueryParams>(query: string, params: Q): Observable<R>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -135,9 +135,9 @@ export class ObservableSanityClient {
    * @param params - Query parameters
    * @param options - Request options
    */
-  fetch<R = FIXME>(
+  fetch<R = FIXME, Q = QueryParams>(
     query: string,
-    params: QueryParams | undefined,
+    params: Q | undefined,
     options: FilteredResponseQueryOptions
   ): Observable<R>
   /**
@@ -147,17 +147,17 @@ export class ObservableSanityClient {
    * @param params - Query parameters
    * @param options - Request options
    */
-  fetch<R = FIXME>(
+  fetch<R = FIXME, Q = QueryParams>(
     query: string,
-    params: QueryParams | undefined,
+    params: Q | undefined,
     options: UnfilteredResponseQueryOptions
   ): Observable<RawQueryResponse<R>>
-  fetch<R = FIXME>(
+  fetch<R, Q extends QueryParams>(
     query: string,
-    params?: QueryParams,
+    params?: Q,
     options: FilteredResponseQueryOptions | UnfilteredResponseQueryOptions = {}
   ): Observable<RawQueryResponse<R> | R> {
-    return dataMethods._fetch<R>(this, this.#httpRequest, query, params, options)
+    return dataMethods._fetch<R, Q>(this, this.#httpRequest, query, params, options)
   }
 
   /**
@@ -618,7 +618,6 @@ export class ObservableSanityClient {
 /** @public */
 export class SanityClient {
   assets: AssetsClient
-  auth: AuthClient
   datasets: DatasetsClient
   projects: ProjectsClient
   users: UsersClient
@@ -645,7 +644,6 @@ export class SanityClient {
     this.#httpRequest = httpRequest
 
     this.assets = new AssetsClient(this, this.#httpRequest)
-    this.auth = new AuthClient(this, this.#httpRequest)
     this.datasets = new DatasetsClient(this, this.#httpRequest)
     this.projects = new ProjectsClient(this, this.#httpRequest)
     this.users = new UsersClient(this, this.#httpRequest)
@@ -708,7 +706,7 @@ export class SanityClient {
    * @param query - GROQ-query to perform
    * @param params - Optional query parameters
    */
-  fetch<R = FIXME>(query: string, params: QueryParams): Promise<R>
+  fetch<R = FIXME, Q = QueryParams>(query: string, params: Q): Promise<R>
   /**
    * Perform a GROQ-query against the configured dataset.
    *
@@ -716,9 +714,9 @@ export class SanityClient {
    * @param params - Optional query parameters
    * @param options - Request options
    */
-  fetch<R = FIXME>(
+  fetch<R = FIXME, Q = QueryParams>(
     query: string,
-    params: QueryParams | undefined,
+    params: Q | undefined,
     options: FilteredResponseQueryOptions
   ): Promise<R>
   /**
@@ -728,17 +726,17 @@ export class SanityClient {
    * @param params - Optional query parameters
    * @param options - Request options
    */
-  fetch<R = FIXME>(
+  fetch<R = FIXME, Q = QueryParams>(
     query: string,
-    params: QueryParams | undefined,
+    params: Q | undefined,
     options: UnfilteredResponseQueryOptions
   ): Promise<RawQueryResponse<R>>
-  fetch<R = FIXME>(
+  fetch<R, Q extends QueryParams>(
     query: string,
-    params?: QueryParams,
+    params?: Q,
     options: FilteredResponseQueryOptions | UnfilteredResponseQueryOptions = {}
   ): Promise<RawQueryResponse<R> | R> {
-    return lastValueFrom(dataMethods._fetch<R>(this, this.#httpRequest, query, params, options))
+    return lastValueFrom(dataMethods._fetch<R, Q>(this, this.#httpRequest, query, params, options))
   }
 
   /**

package/src/assets/AssetsClient.ts

@@ -26,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
    */
@@ -39,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
    */
@@ -48,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,
@@ -69,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
    */
@@ -81,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
    */
@@ -90,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,

package/src/data/dataMethods.ts

@@ -60,11 +60,11 @@ const indexBy = (docs: FIXME[], attr: FIXME) =>
 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 =

package/src/data/encodeQueryString.ts

@@ -1,28 +1,29 @@
 import type {FIXME, QueryParams} from '../types'
 
-const enc = encodeURIComponent
-
 export default ({
   query,
-  params = {} as FIXME,
-  options = {} as FIXME,
+  params = {},
+  options = {},
 }: {
   query: string
   params?: QueryParams
   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/patch.ts

@@ -28,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()`