@sanity/client 5.0.0-esm.9 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "5.0.0-esm.9",
+  "version": "5.0.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -18,7 +18,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/sanity-io/client.git"
+    "url": "git+ssh://git@github.com/sanity-io/client.git"
   },
   "license": "MIT",
   "author": "Sanity.io <hello@sanity.io>",
@@ -91,38 +91,37 @@
     "@sanity/eventsource": "^4",
     "@types/node": "^18.11.18",
     "get-it": "^8",
-    "make-error": "^1.3.6",
     "rxjs": "^7"
   },
   "devDependencies": {
-    "@edge-runtime/types": "^2.0.2",
-    "@edge-runtime/vm": "^2.0.2",
-    "@rollup/plugin-commonjs": "^24.0.0",
+    "@edge-runtime/types": "^2.0.3",
+    "@edge-runtime/vm": "^2.0.3",
+    "@rollup/plugin-commonjs": "^24.0.1",
     "@rollup/plugin-node-resolve": "^15.0.1",
-    "@sanity/pkg-utils": "^2.1.1",
-    "@sanity/semantic-release-preset": "^3.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.48.1",
-    "@typescript-eslint/parser": "^5.48.1",
-    "@vitest/coverage-c8": "^0.27.1",
-    "eslint": "^8.31.0",
+    "@sanity/pkg-utils": "^2.2.3",
+    "@sanity/semantic-release-preset": "^4.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.50.0",
+    "@typescript-eslint/parser": "^5.50.0",
+    "@vitest/coverage-c8": "^0.28.3",
+    "eslint": "^8.33.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-simple-import-sort": "^8.0.0",
+    "eslint-plugin-simple-import-sort": "^10.0.0",
     "faucet": "^0.0.3",
-    "happy-dom": "^8.1.3",
-    "ls-engines": "^0.8.0",
+    "happy-dom": "^8.2.3",
+    "ls-engines": "^0.9.0",
     "nock": "^13.3.0",
-    "prettier": "^2.8.2",
-    "prettier-plugin-packagejson": "^2.3.0",
-    "rimraf": "^3.0.2",
-    "rollup": "^3.10.0",
+    "prettier": "^2.8.3",
+    "prettier-plugin-packagejson": "^2.4.2",
+    "rimraf": "^4.1.2",
+    "rollup": "^3.12.1",
     "sse-channel": "^4.0.0",
-    "terser": "^5.16.1",
-    "typescript": "^4.9.4",
-    "vitest": "^0.27.1",
+    "terser": "^5.16.2",
+    "typescript": "^4.9.5",
+    "vitest": "^0.28.3",
     "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)
   }
 
   /**
@@ -177,7 +177,7 @@ export class ObservableSanityClient {
    * Fetch multiple documents in one request.
    * Should be used sparingly - performing a query is usually a better option.
    * The order/position of documents is preserved based on the original array of IDs.
-   * If a FIXME of the documents are missing, they will be replaced by a `null` entry in the returned array
+   * If any of the documents are missing, they will be replaced by a `null` entry in the returned array
    *
    * @param ids - Document IDs to fetch
    * @param options - Request 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))
   }
 
   /**
@@ -758,7 +756,7 @@ export class SanityClient {
    * Fetch multiple documents in one request.
    * Should be used sparingly - performing a query is usually a better option.
    * The order/position of documents is preserved based on the original array of IDs.
-   * If a FIXME of the documents are missing, they will be replaced by a `null` entry in the returned array
+   * If any of the documents are missing, they will be replaced by a `null` entry in the returned array
    *
    * @param ids - Document IDs to fetch
    * @param options - Request options

package/src/assets/AssetsClient.ts

@@ -1,4 +1,4 @@
-import {type Observable, lastValueFrom} from 'rxjs'
+import {lastValueFrom, type Observable} from 'rxjs'
 import {filter, map} from 'rxjs/operators'
 
 import {_requestObservable} from '../data/dataMethods'
@@ -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/listen.ts

@@ -1,7 +1,7 @@
 import polyfilledEventSource from '@sanity/eventsource'
 import {Observable} from 'rxjs'
 
-import type {SanityClient} from '../SanityClient'
+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'
@@ -35,7 +35,7 @@ const defaultOptions = {
  * @internal
  */
 export function _listen<R extends Record<string, FIXME> = Record<string, FIXME>>(
-  this: SanityClient,
+  this: SanityClient | ObservableSanityClient,
   query: string,
   params?: QueryParams
 ): Observable<MutationEvent<R>>
@@ -48,14 +48,14 @@ export function _listen<R extends Record<string, FIXME> = Record<string, FIXME>>
  * @internal
  */
 export function _listen<R extends Record<string, FIXME> = Record<string, FIXME>>(
-  this: SanityClient,
+  this: SanityClient | ObservableSanityClient,
   query: string,
   params?: QueryParams,
   options?: ListenOptions
 ): Observable<ListenEvent<R>>
 /** @internal */
 export function _listen<R extends Record<string, FIXME> = Record<string, FIXME>>(
-  this: SanityClient,
+  this: SanityClient | ObservableSanityClient,
   query: string,
   params?: QueryParams,
   opts: ListenOptions = {}

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()`
@@ -142,7 +130,7 @@ export class BasePatch {
    * @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 FIXME elements, splice() will only remove elements from the array.
+   * @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?: FIXME[]): this {
     // Negative indexes doesn't mean the same in Sanity as they do in JS;

package/src/datasets/DatasetsClient.ts

@@ -1,4 +1,4 @@
-import {type Observable, lastValueFrom} from 'rxjs'
+import {lastValueFrom, type Observable} from 'rxjs'
 
 import {_request} from '../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'

package/src/generateHelpUrl.ts

@@ -1,4 +1,4 @@
-const BASE_URL = 'https://docs.sanity.io/help/'
+const BASE_URL = 'https://www.sanity.io/help/'
 
 export default function generateHelpUrl(slug: string) {
   return BASE_URL + slug

package/src/http/errors.ts

@@ -1,9 +1,7 @@
-import {BaseError} from 'make-error'
-
-import {ErrorProps, FIXME} from '../types'
+import type {ErrorProps, FIXME} from '../types'
 
 /** @public */
-export class ClientError extends BaseError {
+export class ClientError extends Error {
   response: ErrorProps['response']
   statusCode: ErrorProps['statusCode'] = 400
   responseBody: ErrorProps['responseBody']
@@ -17,7 +15,7 @@ export class ClientError extends BaseError {
 }
 
 /** @public */
-export class ServerError extends BaseError {
+export class ServerError extends Error {
   response: ErrorProps['response']
   statusCode: ErrorProps['statusCode'] = 500
   responseBody: ErrorProps['responseBody']

package/src/http/request.ts

@@ -1,4 +1,4 @@
-import {type Middlewares, getIt} from 'get-it'
+import {getIt, type Middlewares} from 'get-it'
 import {jsonRequest, jsonResponse, observable, progress} from 'get-it/middleware'
 import {Observable} from 'rxjs'
 

package/src/projects/ProjectsClient.ts

@@ -1,4 +1,4 @@
-import {type Observable, lastValueFrom} from 'rxjs'
+import {lastValueFrom, type Observable} from 'rxjs'
 
 import {_request} from '../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'

package/src/users/UsersClient.ts

@@ -1,4 +1,4 @@
-import {type Observable, lastValueFrom} from 'rxjs'
+import {lastValueFrom, type Observable} from 'rxjs'
 
 import {_request} from '../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'

package/src/warnings.ts

@@ -8,7 +8,7 @@ const createWarningPrinter = (message: string[]) =>
 
 export const printCdnWarning = createWarningPrinter([
   'You are not using the Sanity CDN. That means your data is always fresh, but the CDN is faster and',
-  `cheaper. Think about it! For more info, see ${generateHelpUrl('js-client-cdn-configuration')}.`,
+  `cheaper. Think about it! For more info, see ${generateHelpUrl('js-client-cdn-configuration')} `,
   'To hide this warning, please set the `useCdn` option to either `true` or `false` when creating',
   'the client.',
 ])