@sanity/client 7.26.2 → 8.0.0

package/src/agent/actions/patch.ts

@@ -1,6 +1,6 @@
 import {type Observable} from 'rxjs'
 
-import {_request} from '../../data/dataMethods'
+import {_request, _requestObservable} from '../../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../../SanityClient'
 import type {
   AgentActionPath,
@@ -16,7 +16,7 @@ import type {AgentActionAsync, AgentActionSchema, AgentActionSync} from './commo
 /**  @beta */
 export type PatchOperation = 'set' | 'append' | 'mixed' | 'unset'
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
+// oxlint-disable-next-line typescript/no-explicit-any
 type AnyNonNullable = Exclude<any, null | undefined>
 
 /**  @beta */
@@ -99,23 +99,26 @@ interface PatchTargetDocumentRequest<T extends Record<string, Any> = Record<stri
 
 /** @beta */
 export type PatchDocumentSync<T extends Record<string, Any> = Record<string, Any>> = (
-  PatchExistingDocumentRequest | PatchTargetDocumentRequest<T>
+  | PatchExistingDocumentRequest
+  | PatchTargetDocumentRequest<T>
 ) &
   PatchRequestBase &
   AgentActionSync
 
 /** @beta */
 export type PatchDocumentAsync<T extends Record<string, Any> = Record<string, Any>> = (
-  PatchExistingDocumentRequest | PatchTargetDocumentRequest<T>
+  | PatchExistingDocumentRequest
+  | PatchTargetDocumentRequest<T>
 ) &
   PatchRequestBase &
   AgentActionAsync
 
 /** @beta */
 export type PatchDocument<T extends Record<string, Any> = Record<string, Any>> =
-  PatchDocumentSync<T> | PatchDocumentAsync<T>
+  | PatchDocumentSync<T>
+  | PatchDocumentAsync<T>
 
-export function _patch<DocumentShape extends Record<string, Any>>(
+export function _patchObservable<DocumentShape extends Record<string, Any>>(
   client: SanityClient | ObservableSanityClient,
   httpRequest: HttpRequest,
   request: PatchDocument<DocumentShape>,
@@ -123,11 +126,28 @@ export function _patch<DocumentShape extends Record<string, Any>>(
   (typeof request)['async'] extends true
     ? {_id: string}
     : IdentifiedSanityDocumentStub & DocumentShape
+> {
+  const dataset = hasDataset(client.config())
+  return _requestObservable(client, httpRequest, {
+    method: 'POST',
+    url: `/agent/action/patch/${dataset}`,
+    body: request,
+  })
+}
+
+export function _patch<DocumentShape extends Record<string, Any>>(
+  client: SanityClient | ObservableSanityClient,
+  httpRequest: HttpRequest,
+  request: PatchDocument<DocumentShape>,
+): Promise<
+  (typeof request)['async'] extends true
+    ? {_id: string}
+    : IdentifiedSanityDocumentStub & DocumentShape
 > {
   const dataset = hasDataset(client.config())
   return _request(client, httpRequest, {
     method: 'POST',
-    uri: `/agent/action/patch/${dataset}`,
+    url: `/agent/action/patch/${dataset}`,
     body: request,
   })
 }

package/src/agent/actions/prompt.ts

@@ -1,6 +1,6 @@
 import {type Observable} from 'rxjs'
 
-import {_request} from '../../data/dataMethods'
+import {_request, _requestObservable} from '../../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../../SanityClient'
 import type {AgentActionParams, Any, HttpRequest} from '../../types'
 import {hasDataset} from '../../validators'
@@ -101,7 +101,7 @@ export interface PromptRequestBase {
  * @beta
  */
 // need the unused generic here to allow for optional callsite casting
-// eslint-disable-next-line unused-imports/no-unused-vars
+// oxlint-disable-next-line no-unused-vars
 interface PromptJsonResponse<T extends Record<string, Any> = Record<string, Any>> {
   /**
    *
@@ -120,19 +120,33 @@ interface PromptTextResponse {
 
 /** @beta */
 export type PromptRequest<T extends Record<string, Any> = Record<string, Any>> = (
-  PromptTextResponse | PromptJsonResponse<T>
+  | PromptTextResponse
+  | PromptJsonResponse<T>
 ) &
   PromptRequestBase
 
-export function _prompt<const DocumentShape extends Record<string, Any>>(
+export function _promptObservable<const DocumentShape extends Record<string, Any>>(
   client: SanityClient | ObservableSanityClient,
   httpRequest: HttpRequest,
   request: PromptRequest<DocumentShape>,
 ): Observable<(typeof request)['format'] extends 'json' ? DocumentShape : string> {
+  const dataset = hasDataset(client.config())
+  return _requestObservable(client, httpRequest, {
+    method: 'POST',
+    url: `/agent/action/prompt/${dataset}`,
+    body: request,
+  })
+}
+
+export function _prompt<const DocumentShape extends Record<string, Any>>(
+  client: SanityClient | ObservableSanityClient,
+  httpRequest: HttpRequest,
+  request: PromptRequest<DocumentShape>,
+): Promise<(typeof request)['format'] extends 'json' ? DocumentShape : string> {
   const dataset = hasDataset(client.config())
   return _request(client, httpRequest, {
     method: 'POST',
-    uri: `/agent/action/prompt/${dataset}`,
+    url: `/agent/action/prompt/${dataset}`,
     body: request,
   })
 }

package/src/agent/actions/transform.ts

@@ -1,6 +1,6 @@
 import {type Observable} from 'rxjs'
 
-import {_request} from '../../data/dataMethods'
+import {_request, _requestObservable} from '../../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../../SanityClient'
 import type {
   AgentActionParams,
@@ -313,7 +313,7 @@ export interface TransformTarget extends AgentActionTarget {
 
 /** @beta */
 // need the generics to hold optional call-site response generics
-// eslint-disable-next-line unused-imports/no-unused-vars
+// oxlint-disable-next-line no-unused-vars
 export type TransformDocumentSync<T extends Record<string, Any> = Record<string, Any>> =
   TransformRequestBase & AgentActionSync
 
@@ -322,9 +322,10 @@ export type TransformDocumentAsync = TransformRequestBase & AgentActionAsync
 
 /** @beta */
 export type TransformDocument<T extends Record<string, Any> = Record<string, Any>> =
-  TransformDocumentSync<T> | TransformDocumentAsync
+  | TransformDocumentSync<T>
+  | TransformDocumentAsync
 
-export function _transform<DocumentShape extends Record<string, Any>>(
+export function _transformObservable<DocumentShape extends Record<string, Any>>(
   client: SanityClient | ObservableSanityClient,
   httpRequest: HttpRequest,
   request: TransformDocument<DocumentShape>,
@@ -332,11 +333,28 @@ export function _transform<DocumentShape extends Record<string, Any>>(
   (typeof request)['async'] extends true
     ? {_id: string}
     : IdentifiedSanityDocumentStub & DocumentShape
+> {
+  const dataset = hasDataset(client.config())
+  return _requestObservable(client, httpRequest, {
+    method: 'POST',
+    url: `/agent/action/transform/${dataset}`,
+    body: request,
+  })
+}
+
+export function _transform<DocumentShape extends Record<string, Any>>(
+  client: SanityClient | ObservableSanityClient,
+  httpRequest: HttpRequest,
+  request: TransformDocument<DocumentShape>,
+): Promise<
+  (typeof request)['async'] extends true
+    ? {_id: string}
+    : IdentifiedSanityDocumentStub & DocumentShape
 > {
   const dataset = hasDataset(client.config())
   return _request(client, httpRequest, {
     method: 'POST',
-    uri: `/agent/action/transform/${dataset}`,
+    url: `/agent/action/transform/${dataset}`,
     body: request,
   })
 }

package/src/agent/actions/translate.ts

@@ -1,6 +1,6 @@
 import {type Observable} from 'rxjs'
 
-import {_request} from '../../data/dataMethods'
+import {_request, _requestObservable} from '../../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../../SanityClient'
 import type {
   AgentActionParams,
@@ -138,7 +138,7 @@ export interface TranslateTarget extends AgentActionTarget {
 
 /** @beta */
 // need the generics to hold optional call-site response generics
-// eslint-disable-next-line unused-imports/no-unused-vars
+// oxlint-disable-next-line no-unused-vars
 export type TranslateDocumentSync<T extends Record<string, Any> = Record<string, Any>> =
   TranslateRequestBase & AgentActionSync
 
@@ -147,9 +147,10 @@ export type TranslateDocumentAsync = TranslateRequestBase & AgentActionAsync
 
 /** @beta */
 export type TranslateDocument<T extends Record<string, Any> = Record<string, Any>> =
-  TranslateDocumentSync<T> | TranslateDocumentAsync
+  | TranslateDocumentSync<T>
+  | TranslateDocumentAsync
 
-export function _translate<DocumentShape extends Record<string, Any>>(
+export function _translateObservable<DocumentShape extends Record<string, Any>>(
   client: SanityClient | ObservableSanityClient,
   httpRequest: HttpRequest,
   request: TranslateDocument<DocumentShape>,
@@ -157,11 +158,28 @@ export function _translate<DocumentShape extends Record<string, Any>>(
   (typeof request)['async'] extends true
     ? {_id: string}
     : IdentifiedSanityDocumentStub & DocumentShape
+> {
+  const dataset = hasDataset(client.config())
+  return _requestObservable(client, httpRequest, {
+    method: 'POST',
+    url: `/agent/action/translate/${dataset}`,
+    body: request,
+  })
+}
+
+export function _translate<DocumentShape extends Record<string, Any>>(
+  client: SanityClient | ObservableSanityClient,
+  httpRequest: HttpRequest,
+  request: TranslateDocument<DocumentShape>,
+): Promise<
+  (typeof request)['async'] extends true
+    ? {_id: string}
+    : IdentifiedSanityDocumentStub & DocumentShape
 > {
   const dataset = hasDataset(client.config())
   return _request(client, httpRequest, {
     method: 'POST',
-    uri: `/agent/action/translate/${dataset}`,
+    url: `/agent/action/translate/${dataset}`,
     body: request,
   })
 }

package/src/assets/AssetsClient.ts

@@ -1,18 +1,19 @@
-import {lastValueFrom, type Observable} from 'rxjs'
-import {filter, map} from 'rxjs/operators'
+import {defer, lastValueFrom, type Observable} from 'rxjs'
+import {filter, map, mergeAll} from 'rxjs/operators'
 
-import {_requestObservable} from '../data/dataMethods'
+import {_prepareRequest, _uploadObservable} from '../data/dataMethods'
+import type {FetchRequest} from '../http/requestOptions'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import type {
   Any,
   HttpRequest,
-  HttpRequestEvent,
   InitializedClientConfig,
-  ResponseEvent,
   SanityAssetDocument,
   SanityImageAssetDocument,
   UploadBody,
   UploadClientConfig,
+  UploadEvent,
+  UploadResponseEvent,
 } from '../types'
 import * as validators from '../validators'
 
@@ -36,7 +37,7 @@ export class ObservableAssetsClient {
     assetType: 'file',
     body: UploadBody,
     options?: UploadClientConfig,
-  ): Observable<HttpRequestEvent<{document: SanityAssetDocument}>>
+  ): Observable<UploadEvent<{document: SanityAssetDocument}>>
 
   /**
    * Uploads an image asset to the configured dataset
@@ -49,7 +50,7 @@ export class ObservableAssetsClient {
     assetType: 'image',
     body: UploadBody,
     options?: UploadClientConfig,
-  ): Observable<HttpRequestEvent<{document: SanityImageAssetDocument}>>
+  ): Observable<UploadEvent<{document: SanityImageAssetDocument}>>
   /**
    * Uploads a file or an image asset to the configured dataset
    *
@@ -61,12 +62,12 @@ export class ObservableAssetsClient {
     assetType: 'file' | 'image',
     body: UploadBody,
     options?: UploadClientConfig,
-  ): Observable<HttpRequestEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>>
+  ): Observable<UploadEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>>
   upload(
     assetType: 'file' | 'image',
     body: UploadBody,
     options?: UploadClientConfig,
-  ): Observable<HttpRequestEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>> {
+  ): Observable<UploadEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>> {
     return _upload(this.#client, this.#httpRequest, assetType, body, options)
   }
 }
@@ -121,27 +122,24 @@ export class AssetsClient {
     body: UploadBody,
     options?: UploadClientConfig,
   ): Promise<SanityAssetDocument | SanityImageAssetDocument> {
-    const observable = _upload(this.#client, this.#httpRequest, assetType, body, options)
+    type Doc = {document: SanityAssetDocument | SanityImageAssetDocument}
+    const observable = _upload<Doc>(this.#client, this.#httpRequest, assetType, body, options)
     return lastValueFrom(
       observable.pipe(
-        filter((event: Any) => event.type === 'response'),
-        map(
-          (event) =>
-            (event as ResponseEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>)
-              .body.document,
-        ),
+        filter((event): event is UploadResponseEvent<Doc> => event.type === 'response'),
+        map((event) => event.body.document),
       ),
     )
   }
 }
 
-function _upload(
+function _upload<T = {document: SanityAssetDocument | SanityImageAssetDocument}>(
   client: SanityClient | ObservableSanityClient,
-  httpRequest: HttpRequest,
+  _httpRequest: HttpRequest,
   assetType: 'image' | 'file',
   body: UploadBody,
   opts: UploadClientConfig = {},
-): Observable<HttpRequestEvent<{document: SanityAssetDocument | SanityImageAssetDocument}>> {
+): Observable<UploadEvent<T>> {
   validators.validateAssetType(assetType)
 
   // If an empty array is given, explicitly set `none` to override API defaults
@@ -180,15 +178,65 @@ function _upload(
     query.sourceUrl = source.url
   }
 
-  return _requestObservable(client, httpRequest, {
+  const headers: Record<string, string> = options.contentType
+    ? {'Content-Type': options.contentType}
+    : {}
+  const baseRequest = {
     tag,
     method: 'POST',
+    // Uploads have NO timeout unless the caller opts in — uploads can
+    // legitimately be slow. `0` translates to "disabled" at the request
+    // boundary, which also shields uploads from get-it's default timeout.
     timeout: options.timeout || 0,
-    uri: buildAssetUploadUrl(config, assetType),
-    headers: options.contentType ? {'Content-Type': options.contentType} : {},
+    url: buildAssetUploadUrl(config, assetType),
+    headers,
     query,
     body,
-  })
+  }
+
+  // In browsers, run uploads through `XMLHttpRequest` so we can surface
+  // per-chunk upload progress events — fetch (and therefore get-it v9) has no
+  // equivalent hook. Outside the browser (Node, edge runtimes), we fall back
+  // to the regular fetch-based path which only emits the terminal `response`
+  // event.
+  if (typeof XMLHttpRequest !== 'undefined') {
+    return defer(async () => {
+      const {uploadWithProgress} = await import('../http/browserUpload')
+      // Build the request the same way the fetch path does, so the request
+      // tag (incl. `requestTagPrefix` and validation), auth/custom headers,
+      // credentials and timeout are identical across both upload transports.
+      // The XHR API needs the query baked into the URL, though.
+      const req = _prepareRequest(client, {...baseRequest})
+      return uploadWithProgress<T>({
+        url: appendQuery(req.url, req.query),
+        method: req.method ?? 'POST',
+        headers: req.headers,
+        body,
+        withCredentials: req.credentials === 'include',
+        // XHR only has a single total-deadline timer, so a structured
+        // get-it timeout collapses to its `total` component here.
+        timeout: typeof req.timeout === 'object' ? req.timeout.total : req.timeout,
+        signal: req.signal,
+      })
+    }).pipe(mergeAll())
+  }
+
+  return _uploadObservable<T>(client, baseRequest)
+}
+
+function appendQuery(url: string, query: FetchRequest['query']): string {
+  if (!query) return url
+  const params =
+    query instanceof URLSearchParams
+      ? query
+      : new URLSearchParams(
+          Object.entries(query).flatMap(([key, value]) =>
+            value === undefined || value === null ? [] : [[key, `${value}`]],
+          ),
+        )
+  const qs = params.toString()
+  if (!qs) return url
+  return url + (url.includes('?') ? '&' : '?') + qs
 }
 
 function buildAssetUploadUrl(config: InitializedClientConfig, assetType: 'image' | 'file'): string {

package/src/csm/applySourceDocuments.ts

@@ -24,7 +24,9 @@ export function applySourceDocuments<Result = unknown>(
   getCachedDocument: (
     sourceDocument: ContentSourceMapDocuments[number],
   ) =>
-    (Partial<SanityDocument> & Required<Pick<SanityDocument, '_id' | '_type'>>) | null | undefined,
+    | (Partial<SanityDocument> & Required<Pick<SanityDocument, '_id' | '_type'>>)
+    | null
+    | undefined,
   updateFn: ApplySourceDocumentsUpdateFunction,
   perspective: Exclude<ClientPerspective, 'raw'>,
 ): Result {

package/src/csm/createEditUrl.ts

@@ -36,7 +36,7 @@ export function createEditUrl(options: CreateEditUrlOptions): `${StudioBaseUrl}$
     ? studioPath.toString(jsonPathToStudioPath(path))
     : path
 
-  // eslint-disable-next-line no-warning-comments
+  // oxlint-disable-next-line no-warning-comments
   // @TODO Using searchParams as a temporary workaround until `@sanity/overlays` can decode state from the path reliably
   const searchParams = new URLSearchParams({
     baseUrl,

package/src/csm/draftUtils.ts

@@ -60,7 +60,6 @@ export function getVersionId(id: string, version: string): string {
  */
 export function getVersionFromId(id: string): string | undefined {
   if (!isVersionId(id)) return undefined
-  // eslint-disable-next-line unused-imports/no-unused-vars
   const [_versionPrefix, versionId, ..._publishedId] = id.split(PATH_SEPARATOR)
 
   return versionId

package/src/csm/index.ts

@@ -1,5 +1,5 @@
-import * as studioPath from './studioPath'
-export {studioPath}
+/** @alpha */
+export * as studioPath from './studioPath'
 export * from './applySourceDocuments'
 export {createEditUrl} from './createEditUrl'
 export {

package/src/csm/studioPath.ts

@@ -45,6 +45,7 @@ export function isIndexTuple(segment: PathSegment): segment is IndexTuple {
 }
 
 /** @internal */
+// oxlint-disable-next-line typescript/no-unnecessary-type-parameters -- caller-supplied return type; removing it breaks `get<Result>(...)` call sites
 export function get<Result = unknown, Fallback = unknown>(
   obj: unknown,
   path: Path | string,
@@ -55,7 +56,7 @@ export function get<Result = unknown, Fallback = unknown>(
     throw new Error('Path must be an array or a string')
   }
 
-  let acc: unknown | undefined = obj
+  let acc: unknown = obj
   for (let i = 0; i < select.length; i++) {
     const segment = select[i]
     if (isIndexSegment(segment)) {

package/src/csm/types.ts

@@ -33,11 +33,17 @@ export type ContentSourceMapParsedPathKeyedSegment = {_key: string; _index: numb
 
 /** @alpha */
 export type ContentSourceMapParsedPath = (
-  string | number | ContentSourceMapParsedPathKeyedSegment
+  | string
+  | number
+  | ContentSourceMapParsedPathKeyedSegment
 )[]
 
 /** @alpha */
-export type StudioBaseUrl = `/${string}` | `${string}.sanity.studio` | `https://${string}` | string
+export type StudioBaseUrl =
+  | `/${string}`
+  | `${string}.sanity.studio`
+  | `https://${string}`
+  | (string & {})
 
 /** @alpha */
 export type StudioBaseRoute = {baseUrl: StudioBaseUrl; workspace?: string; tool?: string}