@sanity/client 0.0.0-dev.3 → 0.0.0-dev.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "0.0.0-dev.3",
+  "version": "0.0.0-dev.4",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",
@@ -33,6 +33,7 @@
         "import": "./dist/index.browser.js"
       },
       "deno": "./dist/index.browser.js",
+      "edge-light": "./dist/index.browser.js",
       "worker": "./dist/index.browser.js",
       "source": "./src/index.ts",
       "require": "./dist/index.cjs",
@@ -88,37 +89,37 @@
     "singleQuote": true
   },
   "dependencies": {
-    "@sanity/eventsource": "^4",
-    "get-it": "^8",
-    "rxjs": "^7"
+    "@sanity/eventsource": "5",
+    "get-it": "^8.1",
+    "rxjs": "7"
   },
   "devDependencies": {
-    "@edge-runtime/types": "^2.0.7",
-    "@edge-runtime/vm": "^2.1.1",
+    "@edge-runtime/types": "^2.0.8",
+    "@edge-runtime/vm": "^2.1.2",
     "@rollup/plugin-commonjs": "^24.0.1",
     "@rollup/plugin-node-resolve": "^15.0.1",
-    "@sanity/pkg-utils": "^2.2.6",
-    "@sanity/semantic-release-preset": "^4.0.0",
-    "@types/node": "^18.14.2",
-    "@typescript-eslint/eslint-plugin": "^5.53.0",
-    "@typescript-eslint/parser": "^5.53.0",
-    "@vitest/coverage-c8": "^0.29.2",
-    "eslint": "^8.35.0",
-    "eslint-config-prettier": "^8.6.0",
+    "@sanity/pkg-utils": "^2.2.13",
+    "@sanity/semantic-release-preset": "^4.1.0",
+    "@types/node": "^18.15.10",
+    "@typescript-eslint/eslint-plugin": "^5.57.0",
+    "@typescript-eslint/parser": "^5.57.0",
+    "@vitest/coverage-c8": "^0.29.8",
+    "eslint": "^8.36.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "faucet": "^0.0.4",
     "happy-dom": "^8.9.0",
     "ls-engines": "^0.9.0",
     "nock": "^13.3.0",
-    "prettier": "^2.8.4",
+    "prettier": "^2.8.7",
     "prettier-plugin-packagejson": "^2.4.3",
-    "rimraf": "^4.1.2",
-    "rollup": "^3.17.3",
+    "rimraf": "^4.4.1",
+    "rollup": "^3.20.2",
     "sse-channel": "^4.0.0",
-    "terser": "^5.16.5",
-    "typescript": "^4.9.5",
-    "vitest": "^0.29.2",
+    "terser": "^5.16.8",
+    "typescript": "^5.0.2",
+    "vitest": "^0.29.8",
     "vitest-github-actions-reporter": "^0.10.0"
   },
   "engines": {

package/src/assets/AssetsClient.ts

@@ -10,6 +10,7 @@ import type {
   ResponseEvent,
   SanityAssetDocument,
   SanityImageAssetDocument,
+  UploadBody,
   UploadClientConfig,
 } from '../types'
 import * as validators from '../validators'
@@ -32,7 +33,7 @@ export class ObservableAssetsClient {
    */
   upload(
     assetType: 'file',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Observable<HttpRequestEvent<{document: SanityAssetDocument}>>
 
@@ -45,7 +46,7 @@ export class ObservableAssetsClient {
    */
   upload(
     assetType: 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Observable<HttpRequestEvent<{document: SanityImageAssetDocument}>>
   /**
@@ -57,12 +58,12 @@ export class ObservableAssetsClient {
    */
   upload(
     assetType: 'file' | 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Observable<HttpRequestEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>>
   upload(
     assetType: 'file' | 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Observable<HttpRequestEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>> {
     return _upload(this.#client, this.#httpRequest, assetType, body, options)
@@ -87,7 +88,7 @@ export class AssetsClient {
    */
   upload(
     assetType: 'file',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Promise<SanityAssetDocument>
   /**
@@ -99,7 +100,7 @@ export class AssetsClient {
    */
   upload(
     assetType: 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Promise<SanityImageAssetDocument>
   /**
@@ -111,12 +112,12 @@ export class AssetsClient {
    */
   upload(
     assetType: 'file' | 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Promise<SanityAssetDocument | SanityImageAssetDocument>
   upload(
     assetType: 'file' | 'image',
-    body: File | Blob | Buffer | NodeJS.ReadableStream,
+    body: UploadBody,
     options?: UploadClientConfig
   ): Promise<SanityAssetDocument | SanityImageAssetDocument> {
     const observable = _upload(this.#client, this.#httpRequest, assetType, body, options)
@@ -137,7 +138,7 @@ function _upload(
   client: SanityClient | ObservableSanityClient,
   httpRequest: HttpRequest,
   assetType: 'image' | 'file',
-  body: File | Blob | Buffer | NodeJS.ReadableStream,
+  body: UploadBody,
   opts: UploadClientConfig = {}
 ): Observable<HttpRequestEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>> {
   validators.validateAssetType(assetType)
@@ -177,7 +178,7 @@ function _upload(
 }
 
 function optionsFromFile(opts: Record<string, Any>, file: Any) {
-  if (typeof window === 'undefined' || !(file instanceof window.File)) {
+  if (typeof File === 'undefined' || !(file instanceof File)) {
     return opts
   }
 

package/src/data/dataMethods.ts

@@ -64,21 +64,12 @@ export function _fetch<R, Q extends QueryParams>(
   client: ObservableSanityClient | SanityClient,
   httpRequest: HttpRequest,
   query: string,
-  _params?: Q,
+  params?: Q,
   options: FilteredResponseQueryOptions | UnfilteredResponseQueryOptions = {}
 ): Observable<RawQueryResponse<R> | R> {
   const mapResponse =
     options.filterResponse === false ? (res: Any) => res : (res: Any) => res.result
 
-  let params = _params
-  const {unstable_overlayDrafts, apiVersion} = client.config()
-  if (unstable_overlayDrafts) {
-    if (apiVersion !== 'X') {
-      // eslint-disable-next-line no-console
-      console.error('You need to set `apiVersion` to `X` to use `unstable_overlayDrafts')
-    }
-    params = {...params, draftMode: true} as Any
-  }
   return _dataRequest(client, httpRequest, 'query', {query, params}, options).pipe(map(mapResponse))
 }
 
@@ -310,6 +301,10 @@ export function _requestObservable<R>(
     options.query = {tag: validate.requestTag(tag), ...options.query}
   }
 
+  if (config.encodeStegaSourceMap) {
+    options.query = {encodeHackySourceMap: true, ...options.query}
+  }
+
   const reqOptions = requestOptions(
     config,
     Object.assign({}, options, {

package/src/data/listen.ts

@@ -1,4 +1,3 @@
-import polyfilledEventSource from '@sanity/eventsource'
 import {Observable} from 'rxjs'
 
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
@@ -12,7 +11,6 @@ import {encodeQueryString} from './encodeQueryString'
 // unknown range of headers, but an average EventSource request from Chrome seems
 // to have around 700 bytes of cruft, so let us account for 1.2K to be "safe"
 const MAX_URL_LENGTH = 16000 - 1200
-const EventSource = polyfilledEventSource
 
 const possibleOptions = [
   'includePreviousRevision',
@@ -86,7 +84,15 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
   }
 
   return new Observable((observer) => {
-    let es = getEventSource()
+    let es: InstanceType<typeof import('@sanity/eventsource')>
+    getEventSource()
+      .then((eventSource) => {
+        es = eventSource
+      })
+      .catch((reason) => {
+        observer.error(reason)
+        stop()
+      })
     let reconnectTimer: NodeJS.Timeout
     let stopped = false
 
@@ -107,7 +113,7 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
       // automatically, in which case it sets readyState to `CONNECTING`, but in some cases
       // (like when a laptop lid is closed), it closes the connection. In these cases we need
       // to explicitly reconnect.
-      if (es.readyState === EventSource.CLOSED) {
+      if (es.readyState === es.CLOSED) {
         unsubscribe()
         clearTimeout(reconnectTimer)
         reconnectTimer = setTimeout(open, 100)
@@ -130,10 +136,11 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
     }
 
     function unsubscribe() {
-      es.removeEventListener('error', onError, false)
-      es.removeEventListener('channelError', onChannelError, false)
-      es.removeEventListener('disconnect', onDisconnect, false)
-      listenFor.forEach((type: string) => es.removeEventListener(type, onMessage, false))
+      if (!es) return
+      es.removeEventListener('error', onError)
+      es.removeEventListener('channelError', onChannelError)
+      es.removeEventListener('disconnect', onDisconnect)
+      listenFor.forEach((type: string) => es.removeEventListener(type, onMessage))
       es.close()
     }
 
@@ -143,17 +150,25 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
       }
     }
 
-    function getEventSource() {
+    async function getEventSource(): Promise<InstanceType<typeof import('@sanity/eventsource')>> {
+      const {default: EventSource} = await import('@sanity/eventsource')
       const evs = new EventSource(uri, esOptions)
-      evs.addEventListener('error', onError, false)
-      evs.addEventListener('channelError', onChannelError, false)
-      evs.addEventListener('disconnect', onDisconnect, false)
-      listenFor.forEach((type: string) => evs.addEventListener(type, onMessage, false))
+      evs.addEventListener('error', onError)
+      evs.addEventListener('channelError', onChannelError)
+      evs.addEventListener('disconnect', onDisconnect)
+      listenFor.forEach((type: string) => evs.addEventListener(type, onMessage))
       return evs
     }
 
     function open() {
-      es = getEventSource()
+      getEventSource()
+        .then((eventSource) => {
+          es = eventSource
+        })
+        .catch((reason) => {
+          observer.error(reason)
+          stop()
+        })
     }
 
     function stop() {

package/src/http/errors.ts

@@ -1,4 +1,6 @@
-import type {Any, ErrorProps} from '../types'
+import type {Any, ErrorProps, MutationError} from '../types'
+
+const MAX_ITEMS_IN_ERROR_MESSAGE = 5
 
 /** @public */
 export class ClientError extends Error {
@@ -44,6 +46,22 @@ function extractErrorProps(res: Any): ErrorProps {
     return props
   }
 
+  // Mutation errors (specifically)
+  if (isMutationError(body)) {
+    const allItems = body.error.items || []
+    const items = allItems
+      .slice(0, MAX_ITEMS_IN_ERROR_MESSAGE)
+      .map((item) => item.error?.description)
+      .filter(Boolean)
+    let itemsStr = items.length ? `:\n- ${items.join('\n- ')}` : ''
+    if (allItems.length > MAX_ITEMS_IN_ERROR_MESSAGE) {
+      itemsStr += `\n...and ${allItems.length - MAX_ITEMS_IN_ERROR_MESSAGE} more`
+    }
+    props.message = `${body.error.description}${itemsStr}`
+    props.details = body.error
+    return props
+  }
+
   // Query/database errors ({error: {description, other, arb, props}})
   if (body.error && body.error.description) {
     props.message = body.error.description
@@ -56,6 +74,19 @@ function extractErrorProps(res: Any): ErrorProps {
   return props
 }
 
+function isMutationError(body: Any): body is MutationError {
+  return (
+    isPlainObject(body) &&
+    isPlainObject(body.error) &&
+    body.error.type === 'mutationError' &&
+    typeof body.error.description === 'string'
+  )
+}
+
+function isPlainObject(obj: Any): obj is Record<string, unknown> {
+  return typeof obj === 'object' && obj !== null && !Array.isArray(obj)
+}
+
 function httpErrorMessage(res: Any) {
   const statusMessage = res.statusMessage ? ` ${res.statusMessage}` : ''
   return `${res.method}-request to ${res.url} resulted in HTTP ${res.statusCode}${statusMessage}`

package/src/index.browser.ts

@@ -26,3 +26,6 @@ export default function deprecatedCreateClient(config: ClientConfig) {
   printNoDefaultExport()
   return new SanityClient(httpRequest, config)
 }
+
+/** @alpha */
+export {adapter as unstable__adapter, environment as unstable__environment} from 'get-it'

package/src/index.ts

@@ -26,3 +26,6 @@ export default function deprecatedCreateClient(config: ClientConfig) {
   printNoDefaultExport()
   return new SanityClient(httpRequest, config)
 }
+
+/** @alpha */
+export {adapter as unstable__adapter, environment as unstable__environment} from 'get-it'

package/src/types.ts

@@ -1,3 +1,4 @@
+// deno-lint-ignore-file no-empty-interface
 import type {Requester} from 'get-it'
 
 /**
@@ -6,6 +7,14 @@ import type {Requester} from 'get-it'
  */
 export type Any = any // eslint-disable-line @typescript-eslint/no-explicit-any
 
+declare global {
+  // Declare empty stub interfaces for environments where "dom" lib is not included
+  interface File {}
+}
+
+/** @public */
+export type UploadBody = File | Blob | Buffer | NodeJS.ReadableStream
+
 /** @public */
 export interface RequestOptions {
   timeout?: number
@@ -43,12 +52,7 @@ export interface ClientConfig {
    */
   requester?: Requester
 
-  /**
-   * Experimental, requires apiVersion: 'X' and will overlay drafts on top of published documents
-   * which lets you preview your query on what it'll look like after every document is published.
-   * @alpha
-   */
-  unstable_overlayDrafts?: boolean
+  encodeStegaSourceMap?: boolean
 }
 
 /** @public */
@@ -573,3 +577,28 @@ export interface RawRequestOptions {
   body?: Any
   maxRedirects?: number
 }
+
+/** @internal */
+export interface ApiError {
+  error: string
+  message: string
+  statusCode: number
+}
+
+/** @internal */
+export interface MutationError {
+  error: {
+    type: 'mutationError'
+    description: string
+    items?: MutationErrorItem[]
+  }
+}
+
+/** @internal */
+export interface MutationErrorItem {
+  error: {
+    type: string
+    description: string
+    value?: unknown
+  }
+}

package/src/validators.ts

@@ -30,7 +30,7 @@ export const validateObject = (op: string, val: Any) => {
 }
 
 export const validateDocumentId = (op: string, id: string) => {
-  if (typeof id !== 'string' || !/^[a-z0-9_.-]+$/i.test(id)) {
+  if (typeof id !== 'string' || !/^[a-z0-9_][a-z0-9_.-]{0,127}$/i.test(id) || id.includes('..')) {
     throw new Error(`${op}(): "${id}" is not a valid document ID`)
   }
 }