@sanity/client 7.26.2 → 8.0.0

package/README.md

@@ -60,14 +60,12 @@ export async function updateDocumentTitle(_id, title) {
 - [API](#api)
   - [Creating a client instance](#creating-a-client-instance)
     - [ESM](#esm)
-    - [CommonJS](#commonjs)
     - [TypeScript](#typescript)
     - [Next.js App Router](#nextjs-app-router)
     - [Bun](#bun)
     - [Deno](#deno)
     - [Edge Runtime](#edge-runtime)
     - [Browser ESM CDN](#browser-esm-cdn)
-    - [UMD](#umd)
   - [Specifying API version](#specifying-api-version)
   - [Request tags](#request-tags)
   - [Performing queries](#performing-queries)
@@ -148,23 +146,7 @@ export async function updateDocumentTitle(_id, title) {
     - [Working with signed playback information](#working-with-signed-playback-information)
     - [Downloading MP4 renditions](#downloading-mp4-renditions)
 - [License](#license)
-- [From `v5`](#from-v5)
-  - [The default `useCdn` is changed to `true`](#the-default-usecdn-is-changed-to-true)
-- [From `v4`](#from-v4)
-  - [No longer shipping `ES5`](#no-longer-shipping-es5)
-  - [Node.js `v12` no longer supported](#nodejs-v12-no-longer-supported)
-  - [The `default` export is replaced with the named export `createClient`](#the-default-export-is-replaced-with-the-named-export-createclient)
-  - [`client.assets.delete` is removed](#clientassetsdelete-is-removed)
-  - [`client.assets.getImageUrl` is removed, replace with `@sanity/image-url`](#clientassetsgetimageurl-is-removed-replace-with-sanityimage-url)
-  - [`SanityClient` static properties moved to named exports](#sanityclient-static-properties-moved-to-named-exports)
-  - [`client.clientConfig` is removed, replace with `client.config()`](#clientclientconfig-is-removed-replace-with-clientconfig)
-  - [`client.isPromiseAPI()` is removed, replace with an `instanceof` check](#clientispromiseapi-is-removed-replace-with-an-instanceof-check)
-  - [`client.observable.isObservableAPI()` is removed, replace with an `instanceof` check](#clientobservableisobservableapi-is-removed-replace-with-an-instanceof-check)
-  - [`client._requestObservable` is removed, replace with `client.observable.request`](#client_requestobservable-is-removed-replace-with-clientobservablerequest)
-  - [`client._dataRequest` is removed, replace with `client.dataRequest`](#client_datarequest-is-removed-replace-with-clientdatarequest)
-  - [`client._create_` is removed, replace with one of `client.create`, `client.createIfNotExists` or `client.createOrReplace`](#client_create_-is-removed-replace-with-one-of-clientcreate-clientcreateifnotexists-or-clientcreateorreplace)
-  - [`client.patch.replace` is removed, replace with `client.createOrReplace`](#clientpatchreplace-is-removed-replace-with-clientcreateorreplace)
-  - [`client.auth` is removed, replace with `client.request`](#clientauth-is-removed-replace-with-clientrequest)
+- [Migrate](#migrate)
 
 ## Requirements
 
@@ -208,24 +190,6 @@ const data = await client.fetch(`count(*)`)
 console.log(`Number of documents: ${data}`)
 ```
 
-#### [CommonJS]
-
-```js
-const {createClient} = require('@sanity/client')
-
-const client = createClient({
-  projectId: 'your-project-id',
-  dataset: 'your-dataset-name',
-  useCdn: true, // set to `false` to bypass the edge cache
-  apiVersion: '2025-02-06', // use current date (YYYY-MM-DD) to target the latest API version. Note: this should always be hard coded. Setting API version based on a dynamic value (e.g. new Date()) may break your application at a random point in the future.
-})
-
-client
-  .fetch(`count(*)`)
-  .then((data) => console.log(`Number of documents: ${data}`))
-  .catch(console.error)
-```
-
 #### [TypeScript]
 
 ```ts
@@ -437,51 +401,6 @@ const data = await client.fetch(`count(*)`)
 console.log(`Number of documents: ${data}`)
 ```
 
-#### [UMD][unpkg-dist]
-
-Loading the UMD script creates a `SanityClient` global that have the same exports as `import * as SanityClient from '@sanity/client'`:
-
-```html
-<script src="https://unpkg.com/@sanity/client"></script>
-<!-- Unminified build for debugging -->
-<!--<script src="https://unpkg.com/@sanity/client/umd/sanityClient.js"></script>-->
-<script>
-  const {createClient} = SanityClient
-
-  const client = createClient({
-    projectId: 'your-project-id',
-    dataset: 'your-dataset-name',
-    useCdn: true, // set to `false` to bypass the edge cache
-    apiVersion: '2025-02-06', // use current date (YYYY-MM-DD) to target the latest API version. Note: this should always be hard coded. Setting API version based on a dynamic value (e.g. new Date()) may break your application at a random point in the future.
-  })
-
-  client.fetch(`count(*)`).then((data) => console.log(`Number of documents: ${data}`))
-</script>
-```
-
-The `require-unpkg` library lets you consume `npm` packages from `unpkg.com` similar to how `esm.sh` lets you `import()` anything:
-
-```html
-<div id="results"></div>
-<script src="https://unpkg.com/require-unpkg"></script>
-<script>
-  ;(async () => {
-    // const {createClient} = await require('@sanity/client')
-    const [$, {createClient}] = await require(['jquery', '@sanity/client'])
-
-    const client = createClient({
-      projectId: 'your-project-id',
-      dataset: 'your-dataset-name',
-      useCdn: true, // set to `false` to bypass the edge cache
-      apiVersion: '2025-02-06', // use current date (YYYY-MM-DD) to target the latest API version. Note: this should always be hard coded. Setting API version based on a dynamic value (e.g. new Date()) may break your application at a random point in the future.
-    })
-
-    const data = await client.fetch(`count(*)`)
-    $('#results').text(`Number of documents: ${data}`)
-  })()
-</script>
-```
-
 ### Specifying API version
 
 Sanity uses ISO dates (YYYY-MM-DD) in UTC timezone for versioning. The explanation for this can be found [in the documentation][api-versioning]
@@ -2534,301 +2453,11 @@ MIT © [Sanity.io](https://www.sanity.io/)
 
 # Migrate
 
-## From `v5`
-
-### The default `useCdn` is changed to `true`
-
-It was previously `false`. If you were relying on the default being `false` you can continue using the live API by setting it in the constructor:
-
-```diff
-import {createClient} from '@sanity/client'
-
-export const client = createClient({
-  projectId: 'your-project-id',
-  dataset: 'your-dataset-name',
-  apiVersion: '2025-02-06',
-+ useCdn: false, // set to `true` to use the edge cache
-})
-```
-
-## From `v4`
-
-### No longer shipping `ES5`
-
-The target is changed to [modern browsers] that supports `ES6` `class`, `{...rest}` syntax and more. You may need to update your bundler to a recent major version. Or you could configure your bundler to transpile `@sanity/client`, and `get-it`, which is the engine that powers `@sanity/client` and uses the same output target.
-
-### Node.js `v12` no longer supported
-
-Upgrade to the [LTS release, or one of the Maintenance releases](https://github.com/nodejs/release#release-schedule).
-
-### The `default` export is replaced with the named export `createClient`
-
-Before:
-
-```ts
-import createClient from '@sanity/client'
-const client = createClient()
-```
-
-```ts
-import SanityClient from '@sanity/client'
-const client = new SanityClient()
-```
-
-After:
-
-```ts
-import {createClient} from '@sanity/client'
-const client = createClient()
-```
-
-### `client.assets.delete` is removed
-
-Before:
-
-```ts
-client.assets.delete('image', 'abc123_foobar-123x123-png')
-client.assets.delete('image', 'image-abc123_foobar-123x123-png')
-client.assets.delete({_id: 'image-abc123_foobar-123x123-png'})
-```
-
-After:
-
-```ts
-client.delete('image-abc123_foobar-123x123-png')
-```
-
-### `client.assets.getImageUrl` is removed, replace with [`@sanity/image-url`](https://github.com/sanity-io/image-url)
-
-Before:
-
-```ts
-import createClient from '@sanity/client'
-const client = createClient({projectId: 'abc123', dataset: 'foo'})
-
-client.assets.getImageUrl('image-abc123_foobar-123x123-png')
-client.assets.getImageUrl('image-abc123_foobar-123x123-png', {auto: 'format'})
-client.assets.getImageUrl({_ref: 'image-abc123_foobar-123x123-png'})
-client.assets.getImageUrl({_ref: 'image-abc123_foobar-123x123-png'}, {auto: 'format'})
-```
-
-After:
-
-```bash
-npm install @sanity/image-url
-```
-
-```ts
-import imageUrlBuilder from '@sanity/image-url'
-const builder = imageUrlBuilder({projectId: 'abc123', dataset: 'foo'})
-const urlFor = (source) => builder.image(source)
-
-urlFor('image-abc123_foobar-123x123-png').url()
-urlFor('image-abc123_foobar-123x123-png').auto('format').url()
-urlFor({_ref: 'image-abc123_foobar-123x123-png'}).url()
-urlFor({_ref: 'image-abc123_foobar-123x123-png'}).auto('format').url()
-```
-
-### `SanityClient` static properties moved to named exports
-
-Before:
-
-```ts
-import SanityClient from '@sanity/client'
-
-const {Patch, Transaction, ClientError, ServerError, requester} = SanityClient
-```
-
-After:
-
-```ts
-import {Patch, Transaction, ClientError, ServerError, requester} from '@sanity/client'
-```
-
-### `client.clientConfig` is removed, replace with `client.config()`
-
-Before:
+Migration guides for major version upgrades:
 
-```ts
-import createClient from '@sanity/client'
-const client = createClient()
-
-console.log(client.clientConfig.projectId)
-```
-
-After:
-
-```ts
-import {createClient} from '@sanity/client'
-const client = createClient()
-
-console.log(client.config().projectId)
-```
-
-### `client.isPromiseAPI()` is removed, replace with an `instanceof` check
-
-Before:
-
-```ts
-import createClient from '@sanity/client'
-const client = createClient()
-
-console.log(client.isPromiseAPI())
-console.log(client.clientConfig.isPromiseAPI)
-console.log(client.config().isPromiseAPI)
-```
-
-After:
-
-```ts
-import {createClient, SanityClient} from '@sanity/client'
-const client = createClient()
-
-console.log(client instanceof SanityClient)
-```
-
-### `client.observable.isObservableAPI()` is removed, replace with an `instanceof` check
-
-Before:
-
-```ts
-import createClient from '@sanity/client'
-const client = createClient()
-
-console.log(client.observable.isObservableAPI())
-```
-
-After:
-
-```ts
-import {createClient, ObservableSanityClient} from '@sanity/client'
-const client = createClient()
-
-console.log(client.observable instanceof ObservableSanityClient)
-```
-
-### `client._requestObservable` is removed, replace with `client.observable.request`
-
-Before:
-
-```ts
-import createClient from '@sanity/client'
-const client = createClient()
-
-client._requestObservable({uri: '/ping'}).subscribe()
-```
-
-After:
-
-```ts
-import {createClient} from '@sanity/client'
-const client = createClient()
-
-client.observable.request({uri: '/ping'}).subscribe()
-```
-
-### `client._dataRequest` is removed, replace with `client.dataRequest`
-
-Before:
-
-```ts
-import createClient from '@sanity/client'
-const client = createClient()
-
-client._dataRequest(endpoint, body, options)
-```
-
-After:
-
-```ts
-import {createClient} from '@sanity/client'
-const client = createClient()
-
-client.dataRequest(endpoint, body, options)
-```
-
-### `client._create_` is removed, replace with one of `client.create`, `client.createIfNotExists` or `client.createOrReplace`
-
-Before:
-
-```ts
-import createClient from '@sanity/client'
-const client = createClient()
-
-client._create(doc, 'create', options)
-client._create(doc, 'createIfNotExists', options)
-client._create(doc, 'createOrReplace', options)
-```
-
-After:
-
-```ts
-import {createClient} from '@sanity/client'
-const client = createClient()
-
-client.create(doc, options)
-client.createIfNotExists(doc, options)
-client.createOrReplace(doc, options)
-```
-
-### `client.patch.replace` is removed, replace with `client.createOrReplace`
-
-Before:
-
-```ts
-import createClient from '@sanity/client'
-const client = createClient()
-
-client.patch('tropic-hab').replace({name: 'Tropical Habanero', ingredients: []}).commit()
-```
-
-After:
-
-```ts
-import {createClient} from '@sanity/client'
-const client = createClient()
-
-client.createOrReplace({
-  _id: 'tropic-hab',
-  _type: 'hotsauce',
-  name: 'Tropical Habanero',
-  ingredients: [],
-})
-```
-
-### `client.auth` is removed, replace with `client.request`
-
-Before:
-
-```ts
-import createClient from '@sanity/client'
-const client = createClient()
-
-/**
- * Fetch available login providers
- */
-const loginProviders = await client.auth.getLoginProviders()
-/**
- * Revoke the configured session/token
- */
-await client.auth.logout()
-```
-
-After:
-
-```ts
-import {createclient, type AuthProviderResponse} from '@sanity/client'
-const client = createClient()
-
-/**
- * Fetch available login providers
- */
-const loginProviders = await client.request<AuthProviderResponse>({uri: '/auth/providers'})
-/**
- * Revoke the configured session/token
- */
-await client.request<void>({uri: '/auth/logout', method: 'POST'})
-```
+- From `v7`: [docs/MIGRATE-v7.md](docs/MIGRATE-v7.md)
+- From `v5`: [docs/MIGRATE-v5.md](docs/MIGRATE-v5.md)
+- From `v4`: [docs/MIGRATE-v4.md](docs/MIGRATE-v4.md)
 
 [modern browsers]: https://browsersl.ist/#q=%3E+0.2%25+and+supports+es6-module+and+supports+es6-module-dynamic-import+and+not+dead+and+not+IE+11
 [Deno]: https://deno.land/
@@ -2836,7 +2465,6 @@ await client.request<void>({uri: '/auth/logout', method: 'POST'})
 [Bun]: https://bun.sh/
 [gzip-badge]: https://img.shields.io/bundlephobia/minzip/@sanity/client?label=gzip%20size&style=flat-square
 [size-badge]: https://img.shields.io/bundlephobia/min/@sanity/client?label=size&style=flat-square
-[unpkg-dist]: https://unpkg.com/@sanity/client/umd/
 [bundlephobia]: https://bundlephobia.com/package/@sanity/client
 [esm.sh]: https://esm.sh
 [Node.js]: https://nodejs.org/en/

package/dist/browserUpload-CQgx9YYo.js

@@ -0,0 +1,86 @@
+import { a as ServerError, n as parseJsonText, r as ClientError, s as httpResponseFromFetch } from "./request-CJxcN16k.js";
+import { Observable } from "rxjs";
+import { createDebug } from "obug";
+const log = createDebug("sanity:client");
+let nextRequestId = 1;
+/**
+* Run an asset upload through `XMLHttpRequest` so we can surface per-chunk
+* upload progress events. get-it v9 / fetch has no equivalent hook in the
+* browser, so the observable asset-upload API falls back to this path when
+* `XMLHttpRequest` is available.
+*
+* @internal
+*/
+function uploadWithProgress(options) {
+	return new Observable((subscriber) => {
+		let xhr = new XMLHttpRequest(), requestId = nextRequestId++, { url, method, headers, body, withCredentials, timeout, signal } = options;
+		log("[%d] %s %s (XHR upload with progress)", requestId, method, url), xhr.open(method, url), xhr.withCredentials = withCredentials, typeof timeout == "number" && timeout > 0 && (xhr.timeout = timeout);
+		for (let [key, value] of Object.entries(headers)) xhr.setRequestHeader(key, value);
+		xhr.upload.onprogress = (e) => {
+			subscriber.next({
+				type: "progress",
+				stage: "upload",
+				percent: e.lengthComputable ? Math.round(e.loaded / e.total * 100) : 0,
+				total: e.total || void 0,
+				loaded: e.loaded,
+				lengthComputable: e.lengthComputable
+			});
+		}, xhr.onload = () => {
+			if (log("[%d] %s %s — %d", requestId, method, url, xhr.status), xhr.status >= 400) {
+				let errorHeaders = parseXhrResponseHeaders(xhr.getAllResponseHeaders()), canonical = httpResponseFromFetch({
+					status: xhr.status,
+					statusText: xhr.statusText,
+					headers: errorHeaders,
+					body: parseJsonText(xhr.responseText, errorHeaders)
+				}, url, method);
+				subscriber.error(xhr.status >= 500 ? new ServerError(canonical) : new ClientError(canonical));
+				return;
+			}
+			let responseBody;
+			try {
+				responseBody = JSON.parse(xhr.responseText);
+			} catch {
+				subscriber.error(/* @__PURE__ */ Error("Failed to parse upload response as JSON"));
+				return;
+			}
+			subscriber.next({
+				type: "response",
+				body: responseBody
+			}), subscriber.complete();
+		}, xhr.onerror = () => {
+			log("[%d] %s %s — network error", requestId, method, url), subscriber.error(/* @__PURE__ */ Error("XHR upload network error"));
+		}, xhr.ontimeout = () => {
+			log("[%d] %s %s — timed out after %dms", requestId, method, url, timeout), subscriber.error(new DOMException(`The operation timed out after ${timeout}ms while attempting to reach ${url}`, "TimeoutError"));
+		}, xhr.onabort = () => {
+			subscriber.error(new DOMException("Upload aborted", "AbortError"));
+		};
+		let onSignalAbort = () => xhr.abort();
+		if (signal) {
+			if (signal.aborted) {
+				subscriber.error(new DOMException("Upload aborted", "AbortError"));
+				return;
+			}
+			signal.addEventListener("abort", onSignalAbort, { once: !0 });
+		}
+		return xhr.send(body), () => {
+			signal?.removeEventListener("abort", onSignalAbort), xhr.abort();
+		};
+	});
+}
+/**
+* Parse `XMLHttpRequest.getAllResponseHeaders()` output (CRLF-separated
+* `name: value` lines) into a `Headers` instance.
+*/
+function parseXhrResponseHeaders(raw) {
+	let headers = new Headers();
+	for (let line of raw.split("\r\n")) {
+		let separator = line.indexOf(":");
+		if (!(separator <= 0)) try {
+			headers.append(line.slice(0, separator).trim(), line.slice(separator + 1).trim());
+		} catch {}
+	}
+	return headers;
+}
+export { uploadWithProgress };
+
+//# sourceMappingURL=browserUpload-CQgx9YYo.js.map

package/dist/browserUpload-CQgx9YYo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browserUpload-CQgx9YYo.js","names":[],"sources":["../src/http/browserUpload.ts"],"sourcesContent":["import {createDebug} from 'obug'\nimport {Observable} from 'rxjs'\n\nimport type {UploadEvent} from '../types'\nimport {ClientError, httpResponseFromFetch, ServerError} from './errors'\nimport {parseJsonText} from './request'\n\nconst log = createDebug('sanity:client')\n\nlet nextRequestId = 1\n\n/**\n * Options for a browser-side asset upload that needs progress events.\n *\n * @internal\n */\nexport interface BrowserUploadOptions {\n  url: string\n  method: string\n  headers: Record<string, string>\n  body: unknown\n  withCredentials: boolean\n  /** Milliseconds before the upload is aborted; `false` and `0` both disable the timeout. */\n  timeout?: number | false\n  signal?: AbortSignal\n}\n\n/**\n * Run an asset upload through `XMLHttpRequest` so we can surface per-chunk\n * upload progress events. get-it v9 / fetch has no equivalent hook in the\n * browser, so the observable asset-upload API falls back to this path when\n * `XMLHttpRequest` is available.\n *\n * @internal\n */\nexport function uploadWithProgress<T>(options: BrowserUploadOptions): Observable<UploadEvent<T>> {\n  return new Observable<UploadEvent<T>>((subscriber) => {\n    const xhr = new XMLHttpRequest()\n    const requestId = nextRequestId++\n    const {url, method, headers, body, withCredentials, timeout, signal} = options\n\n    log('[%d] %s %s (XHR upload with progress)', requestId, method, url)\n\n    xhr.open(method, url)\n    xhr.withCredentials = withCredentials\n    if (typeof timeout === 'number' && timeout > 0) {\n      xhr.timeout = timeout\n    }\n\n    for (const [key, value] of Object.entries(headers)) {\n      xhr.setRequestHeader(key, value)\n    }\n\n    xhr.upload.onprogress = (e) => {\n      subscriber.next({\n        type: 'progress',\n        stage: 'upload',\n        percent: e.lengthComputable ? Math.round((e.loaded / e.total) * 100) : 0,\n        total: e.total || undefined,\n        loaded: e.loaded,\n        lengthComputable: e.lengthComputable,\n      })\n    }\n\n    xhr.onload = () => {\n      log('[%d] %s %s — %d', requestId, method, url, xhr.status)\n\n      if (xhr.status >= 400) {\n        // Same typed errors as the fetch transport, so consumers can keep\n        // detecting `ClientError`/`ServerError` and reading `statusCode`,\n        // `responseBody` and the structured API `details` on failed uploads.\n        const errorHeaders = parseXhrResponseHeaders(xhr.getAllResponseHeaders())\n        const canonical = httpResponseFromFetch(\n          {\n            status: xhr.status,\n            statusText: xhr.statusText,\n            headers: errorHeaders,\n            body: parseJsonText(xhr.responseText, errorHeaders),\n          },\n          url,\n          method,\n        )\n        subscriber.error(\n          xhr.status >= 500 ? new ServerError(canonical) : new ClientError(canonical),\n        )\n        return\n      }\n\n      let responseBody: T\n      try {\n        responseBody = JSON.parse(xhr.responseText) as T\n      } catch {\n        subscriber.error(new Error('Failed to parse upload response as JSON'))\n        return\n      }\n\n      subscriber.next({type: 'response', body: responseBody})\n      subscriber.complete()\n    }\n\n    xhr.onerror = () => {\n      log('[%d] %s %s — network error', requestId, method, url)\n      subscriber.error(new Error('XHR upload network error'))\n    }\n\n    xhr.ontimeout = () => {\n      log('[%d] %s %s — timed out after %dms', requestId, method, url, timeout)\n      // Same error shape as the fetch transport's timeout rejection.\n      subscriber.error(\n        new DOMException(\n          `The operation timed out after ${timeout}ms while attempting to reach ${url}`,\n          'TimeoutError',\n        ),\n      )\n    }\n\n    xhr.onabort = () => {\n      subscriber.error(new DOMException('Upload aborted', 'AbortError'))\n    }\n\n    const onSignalAbort = () => xhr.abort()\n    if (signal) {\n      if (signal.aborted) {\n        // `xhr.abort()` before `send()` fires no `abort` event per spec, so\n        // error out directly instead of relying on `onabort`.\n        subscriber.error(new DOMException('Upload aborted', 'AbortError'))\n        return undefined\n      }\n      signal.addEventListener('abort', onSignalAbort, {once: true})\n    }\n\n    xhr.send(body as XMLHttpRequestBodyInit)\n\n    // Unsubscribing cancels the in-flight upload, mirroring how the fetch\n    // path aborts its request (`_observe`). After settle this is a no-op —\n    // except for detaching from the caller's signal, which may be long-lived\n    // and must not accumulate a listener per upload.\n    return () => {\n      signal?.removeEventListener('abort', onSignalAbort)\n      xhr.abort()\n    }\n  })\n}\n\n/**\n * Parse `XMLHttpRequest.getAllResponseHeaders()` output (CRLF-separated\n * `name: value` lines) into a `Headers` instance.\n */\nfunction parseXhrResponseHeaders(raw: string): Headers {\n  const headers = new Headers()\n  for (const line of raw.split('\\r\\n')) {\n    const separator = line.indexOf(':')\n    if (separator <= 0) continue\n    try {\n      headers.append(line.slice(0, separator).trim(), line.slice(separator + 1).trim())\n    } catch {\n      // Skip header lines the Headers constructor rejects — better a partial\n      // header record on the error than no error details at all.\n    }\n  }\n  return headers\n}\n"],"mappings":";;;AAOA,MAAM,MAAM,YAAY,eAAe;AAEvC,IAAI,gBAAgB;;;;;;;;;AA0BpB,SAAgB,mBAAsB,SAA2D;CAC/F,OAAO,IAAI,YAA4B,eAAe;EACpD,IAAM,MAAM,IAAI,eAAe,GACzB,YAAY,iBACZ,EAAC,KAAK,QAAQ,SAAS,MAAM,iBAAiB,SAAS,WAAU;EAMvE,AAJA,IAAI,yCAAyC,WAAW,QAAQ,GAAG,GAEnE,IAAI,KAAK,QAAQ,GAAG,GACpB,IAAI,kBAAkB,iBAClB,OAAO,WAAY,YAAY,UAAU,MAC3C,IAAI,UAAU;EAGhB,KAAK,IAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,OAAO,GAC/C,IAAI,iBAAiB,KAAK,KAAK;EAkEjC,AA/DA,IAAI,OAAO,cAAc,MAAM;GAC7B,WAAW,KAAK;IACd,MAAM;IACN,OAAO;IACP,SAAS,EAAE,mBAAmB,KAAK,MAAO,EAAE,SAAS,EAAE,QAAS,GAAG,IAAI;IACvE,OAAO,EAAE,SAAS,KAAA;IAClB,QAAQ,EAAE;IACV,kBAAkB,EAAE;GACtB,CAAC;EACH,GAEA,IAAI,eAAe;GAGjB,IAFA,IAAI,mBAAmB,WAAW,QAAQ,KAAK,IAAI,MAAM,GAErD,IAAI,UAAU,KAAK;IAIrB,IAAM,eAAe,wBAAwB,IAAI,sBAAsB,CAAC,GAClE,YAAY,sBAChB;KACE,QAAQ,IAAI;KACZ,YAAY,IAAI;KAChB,SAAS;KACT,MAAM,cAAc,IAAI,cAAc,YAAY;IACpD,GACA,KACA,MACF;IACA,WAAW,MACT,IAAI,UAAU,MAAM,IAAI,YAAY,SAAS,IAAI,IAAI,YAAY,SAAS,CAC5E;IACA;GACF;GAEA,IAAI;GACJ,IAAI;IACF,eAAe,KAAK,MAAM,IAAI,YAAY;GAC5C,QAAQ;IACN,WAAW,MAAM,gBAAI,MAAM,yCAAyC,CAAC;IACrE;GACF;GAGA,AADA,WAAW,KAAK;IAAC,MAAM;IAAY,MAAM;GAAY,CAAC,GACtD,WAAW,SAAS;EACtB,GAEA,IAAI,gBAAgB;GAElB,AADA,IAAI,8BAA8B,WAAW,QAAQ,GAAG,GACxD,WAAW,MAAM,gBAAI,MAAM,0BAA0B,CAAC;EACxD,GAEA,IAAI,kBAAkB;GAGpB,AAFA,IAAI,qCAAqC,WAAW,QAAQ,KAAK,OAAO,GAExE,WAAW,MACT,IAAI,aACF,iCAAiC,QAAQ,+BAA+B,OACxE,cACF,CACF;EACF,GAEA,IAAI,gBAAgB;GAClB,WAAW,MAAM,IAAI,aAAa,kBAAkB,YAAY,CAAC;EACnE;EAEA,IAAM,sBAAsB,IAAI,MAAM;EACtC,IAAI,QAAQ;GACV,IAAI,OAAO,SAAS;IAGlB,WAAW,MAAM,IAAI,aAAa,kBAAkB,YAAY,CAAC;IACjE;GACF;GACA,OAAO,iBAAiB,SAAS,eAAe,EAAC,MAAM,GAAI,CAAC;EAC9D;EAQA,OANA,IAAI,KAAK,IAA8B,SAM1B;GAEX,AADA,QAAQ,oBAAoB,SAAS,aAAa,GAClD,IAAI,MAAM;EACZ;CACF,CAAC;AACH;;;;;AAMA,SAAS,wBAAwB,KAAsB;CACrD,IAAM,UAAU,IAAI,QAAQ;CAC5B,KAAK,IAAM,QAAQ,IAAI,MAAM,MAAM,GAAG;EACpC,IAAM,YAAY,KAAK,QAAQ,GAAG;EAC9B,mBAAa,IACjB,IAAI;GACF,QAAQ,OAAO,KAAK,MAAM,GAAG,SAAS,CAAC,CAAC,KAAK,GAAG,KAAK,MAAM,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC;EAClF,QAAQ,CAGR;CACF;CACA,OAAO;AACT"}

package/dist/browserUpload-icWlVP15.js

@@ -0,0 +1,86 @@
+import { a as ServerError, n as parseJsonText, r as ClientError, s as httpResponseFromFetch } from "./request-k7VS_NnC.js";
+import { Observable } from "rxjs";
+import { createDebug } from "obug";
+const log = createDebug("sanity:client");
+let nextRequestId = 1;
+/**
+* Run an asset upload through `XMLHttpRequest` so we can surface per-chunk
+* upload progress events. get-it v9 / fetch has no equivalent hook in the
+* browser, so the observable asset-upload API falls back to this path when
+* `XMLHttpRequest` is available.
+*
+* @internal
+*/
+function uploadWithProgress(options) {
+	return new Observable((subscriber) => {
+		let xhr = new XMLHttpRequest(), requestId = nextRequestId++, { url, method, headers, body, withCredentials, timeout, signal } = options;
+		log("[%d] %s %s (XHR upload with progress)", requestId, method, url), xhr.open(method, url), xhr.withCredentials = withCredentials, typeof timeout == "number" && timeout > 0 && (xhr.timeout = timeout);
+		for (let [key, value] of Object.entries(headers)) xhr.setRequestHeader(key, value);
+		xhr.upload.onprogress = (e) => {
+			subscriber.next({
+				type: "progress",
+				stage: "upload",
+				percent: e.lengthComputable ? Math.round(e.loaded / e.total * 100) : 0,
+				total: e.total || void 0,
+				loaded: e.loaded,
+				lengthComputable: e.lengthComputable
+			});
+		}, xhr.onload = () => {
+			if (log("[%d] %s %s — %d", requestId, method, url, xhr.status), xhr.status >= 400) {
+				let errorHeaders = parseXhrResponseHeaders(xhr.getAllResponseHeaders()), canonical = httpResponseFromFetch({
+					status: xhr.status,
+					statusText: xhr.statusText,
+					headers: errorHeaders,
+					body: parseJsonText(xhr.responseText, errorHeaders)
+				}, url, method);
+				subscriber.error(xhr.status >= 500 ? new ServerError(canonical) : new ClientError(canonical));
+				return;
+			}
+			let responseBody;
+			try {
+				responseBody = JSON.parse(xhr.responseText);
+			} catch {
+				subscriber.error(/* @__PURE__ */ Error("Failed to parse upload response as JSON"));
+				return;
+			}
+			subscriber.next({
+				type: "response",
+				body: responseBody
+			}), subscriber.complete();
+		}, xhr.onerror = () => {
+			log("[%d] %s %s — network error", requestId, method, url), subscriber.error(/* @__PURE__ */ Error("XHR upload network error"));
+		}, xhr.ontimeout = () => {
+			log("[%d] %s %s — timed out after %dms", requestId, method, url, timeout), subscriber.error(new DOMException(`The operation timed out after ${timeout}ms while attempting to reach ${url}`, "TimeoutError"));
+		}, xhr.onabort = () => {
+			subscriber.error(new DOMException("Upload aborted", "AbortError"));
+		};
+		let onSignalAbort = () => xhr.abort();
+		if (signal) {
+			if (signal.aborted) {
+				subscriber.error(new DOMException("Upload aborted", "AbortError"));
+				return;
+			}
+			signal.addEventListener("abort", onSignalAbort, { once: !0 });
+		}
+		return xhr.send(body), () => {
+			signal?.removeEventListener("abort", onSignalAbort), xhr.abort();
+		};
+	});
+}
+/**
+* Parse `XMLHttpRequest.getAllResponseHeaders()` output (CRLF-separated
+* `name: value` lines) into a `Headers` instance.
+*/
+function parseXhrResponseHeaders(raw) {
+	let headers = new Headers();
+	for (let line of raw.split("\r\n")) {
+		let separator = line.indexOf(":");
+		if (!(separator <= 0)) try {
+			headers.append(line.slice(0, separator).trim(), line.slice(separator + 1).trim());
+		} catch {}
+	}
+	return headers;
+}
+export { uploadWithProgress };
+
+//# sourceMappingURL=browserUpload-icWlVP15.js.map

package/dist/browserUpload-icWlVP15.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browserUpload-icWlVP15.js","names":[],"sources":["../src/http/browserUpload.ts"],"sourcesContent":["import {createDebug} from 'obug'\nimport {Observable} from 'rxjs'\n\nimport type {UploadEvent} from '../types'\nimport {ClientError, httpResponseFromFetch, ServerError} from './errors'\nimport {parseJsonText} from './request'\n\nconst log = createDebug('sanity:client')\n\nlet nextRequestId = 1\n\n/**\n * Options for a browser-side asset upload that needs progress events.\n *\n * @internal\n */\nexport interface BrowserUploadOptions {\n  url: string\n  method: string\n  headers: Record<string, string>\n  body: unknown\n  withCredentials: boolean\n  /** Milliseconds before the upload is aborted; `false` and `0` both disable the timeout. */\n  timeout?: number | false\n  signal?: AbortSignal\n}\n\n/**\n * Run an asset upload through `XMLHttpRequest` so we can surface per-chunk\n * upload progress events. get-it v9 / fetch has no equivalent hook in the\n * browser, so the observable asset-upload API falls back to this path when\n * `XMLHttpRequest` is available.\n *\n * @internal\n */\nexport function uploadWithProgress<T>(options: BrowserUploadOptions): Observable<UploadEvent<T>> {\n  return new Observable<UploadEvent<T>>((subscriber) => {\n    const xhr = new XMLHttpRequest()\n    const requestId = nextRequestId++\n    const {url, method, headers, body, withCredentials, timeout, signal} = options\n\n    log('[%d] %s %s (XHR upload with progress)', requestId, method, url)\n\n    xhr.open(method, url)\n    xhr.withCredentials = withCredentials\n    if (typeof timeout === 'number' && timeout > 0) {\n      xhr.timeout = timeout\n    }\n\n    for (const [key, value] of Object.entries(headers)) {\n      xhr.setRequestHeader(key, value)\n    }\n\n    xhr.upload.onprogress = (e) => {\n      subscriber.next({\n        type: 'progress',\n        stage: 'upload',\n        percent: e.lengthComputable ? Math.round((e.loaded / e.total) * 100) : 0,\n        total: e.total || undefined,\n        loaded: e.loaded,\n        lengthComputable: e.lengthComputable,\n      })\n    }\n\n    xhr.onload = () => {\n      log('[%d] %s %s — %d', requestId, method, url, xhr.status)\n\n      if (xhr.status >= 400) {\n        // Same typed errors as the fetch transport, so consumers can keep\n        // detecting `ClientError`/`ServerError` and reading `statusCode`,\n        // `responseBody` and the structured API `details` on failed uploads.\n        const errorHeaders = parseXhrResponseHeaders(xhr.getAllResponseHeaders())\n        const canonical = httpResponseFromFetch(\n          {\n            status: xhr.status,\n            statusText: xhr.statusText,\n            headers: errorHeaders,\n            body: parseJsonText(xhr.responseText, errorHeaders),\n          },\n          url,\n          method,\n        )\n        subscriber.error(\n          xhr.status >= 500 ? new ServerError(canonical) : new ClientError(canonical),\n        )\n        return\n      }\n\n      let responseBody: T\n      try {\n        responseBody = JSON.parse(xhr.responseText) as T\n      } catch {\n        subscriber.error(new Error('Failed to parse upload response as JSON'))\n        return\n      }\n\n      subscriber.next({type: 'response', body: responseBody})\n      subscriber.complete()\n    }\n\n    xhr.onerror = () => {\n      log('[%d] %s %s — network error', requestId, method, url)\n      subscriber.error(new Error('XHR upload network error'))\n    }\n\n    xhr.ontimeout = () => {\n      log('[%d] %s %s — timed out after %dms', requestId, method, url, timeout)\n      // Same error shape as the fetch transport's timeout rejection.\n      subscriber.error(\n        new DOMException(\n          `The operation timed out after ${timeout}ms while attempting to reach ${url}`,\n          'TimeoutError',\n        ),\n      )\n    }\n\n    xhr.onabort = () => {\n      subscriber.error(new DOMException('Upload aborted', 'AbortError'))\n    }\n\n    const onSignalAbort = () => xhr.abort()\n    if (signal) {\n      if (signal.aborted) {\n        // `xhr.abort()` before `send()` fires no `abort` event per spec, so\n        // error out directly instead of relying on `onabort`.\n        subscriber.error(new DOMException('Upload aborted', 'AbortError'))\n        return undefined\n      }\n      signal.addEventListener('abort', onSignalAbort, {once: true})\n    }\n\n    xhr.send(body as XMLHttpRequestBodyInit)\n\n    // Unsubscribing cancels the in-flight upload, mirroring how the fetch\n    // path aborts its request (`_observe`). After settle this is a no-op —\n    // except for detaching from the caller's signal, which may be long-lived\n    // and must not accumulate a listener per upload.\n    return () => {\n      signal?.removeEventListener('abort', onSignalAbort)\n      xhr.abort()\n    }\n  })\n}\n\n/**\n * Parse `XMLHttpRequest.getAllResponseHeaders()` output (CRLF-separated\n * `name: value` lines) into a `Headers` instance.\n */\nfunction parseXhrResponseHeaders(raw: string): Headers {\n  const headers = new Headers()\n  for (const line of raw.split('\\r\\n')) {\n    const separator = line.indexOf(':')\n    if (separator <= 0) continue\n    try {\n      headers.append(line.slice(0, separator).trim(), line.slice(separator + 1).trim())\n    } catch {\n      // Skip header lines the Headers constructor rejects — better a partial\n      // header record on the error than no error details at all.\n    }\n  }\n  return headers\n}\n"],"mappings":";;;AAOA,MAAM,MAAM,YAAY,eAAe;AAEvC,IAAI,gBAAgB;;;;;;;;;AA0BpB,SAAgB,mBAAsB,SAA2D;CAC/F,OAAO,IAAI,YAA4B,eAAe;EACpD,IAAM,MAAM,IAAI,eAAe,GACzB,YAAY,iBACZ,EAAC,KAAK,QAAQ,SAAS,MAAM,iBAAiB,SAAS,WAAU;EAMvE,AAJA,IAAI,yCAAyC,WAAW,QAAQ,GAAG,GAEnE,IAAI,KAAK,QAAQ,GAAG,GACpB,IAAI,kBAAkB,iBAClB,OAAO,WAAY,YAAY,UAAU,MAC3C,IAAI,UAAU;EAGhB,KAAK,IAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,OAAO,GAC/C,IAAI,iBAAiB,KAAK,KAAK;EAkEjC,AA/DA,IAAI,OAAO,cAAc,MAAM;GAC7B,WAAW,KAAK;IACd,MAAM;IACN,OAAO;IACP,SAAS,EAAE,mBAAmB,KAAK,MAAO,EAAE,SAAS,EAAE,QAAS,GAAG,IAAI;IACvE,OAAO,EAAE,SAAS,KAAA;IAClB,QAAQ,EAAE;IACV,kBAAkB,EAAE;GACtB,CAAC;EACH,GAEA,IAAI,eAAe;GAGjB,IAFA,IAAI,mBAAmB,WAAW,QAAQ,KAAK,IAAI,MAAM,GAErD,IAAI,UAAU,KAAK;IAIrB,IAAM,eAAe,wBAAwB,IAAI,sBAAsB,CAAC,GAClE,YAAY,sBAChB;KACE,QAAQ,IAAI;KACZ,YAAY,IAAI;KAChB,SAAS;KACT,MAAM,cAAc,IAAI,cAAc,YAAY;IACpD,GACA,KACA,MACF;IACA,WAAW,MACT,IAAI,UAAU,MAAM,IAAI,YAAY,SAAS,IAAI,IAAI,YAAY,SAAS,CAC5E;IACA;GACF;GAEA,IAAI;GACJ,IAAI;IACF,eAAe,KAAK,MAAM,IAAI,YAAY;GAC5C,QAAQ;IACN,WAAW,MAAM,gBAAI,MAAM,yCAAyC,CAAC;IACrE;GACF;GAGA,AADA,WAAW,KAAK;IAAC,MAAM;IAAY,MAAM;GAAY,CAAC,GACtD,WAAW,SAAS;EACtB,GAEA,IAAI,gBAAgB;GAElB,AADA,IAAI,8BAA8B,WAAW,QAAQ,GAAG,GACxD,WAAW,MAAM,gBAAI,MAAM,0BAA0B,CAAC;EACxD,GAEA,IAAI,kBAAkB;GAGpB,AAFA,IAAI,qCAAqC,WAAW,QAAQ,KAAK,OAAO,GAExE,WAAW,MACT,IAAI,aACF,iCAAiC,QAAQ,+BAA+B,OACxE,cACF,CACF;EACF,GAEA,IAAI,gBAAgB;GAClB,WAAW,MAAM,IAAI,aAAa,kBAAkB,YAAY,CAAC;EACnE;EAEA,IAAM,sBAAsB,IAAI,MAAM;EACtC,IAAI,QAAQ;GACV,IAAI,OAAO,SAAS;IAGlB,WAAW,MAAM,IAAI,aAAa,kBAAkB,YAAY,CAAC;IACjE;GACF;GACA,OAAO,iBAAiB,SAAS,eAAe,EAAC,MAAM,GAAI,CAAC;EAC9D;EAQA,OANA,IAAI,KAAK,IAA8B,SAM1B;GAEX,AADA,QAAQ,oBAAoB,SAAS,aAAa,GAClD,IAAI,MAAM;EACZ;CACF,CAAC;AACH;;;;;AAMA,SAAS,wBAAwB,KAAsB;CACrD,IAAM,UAAU,IAAI,QAAQ;CAC5B,KAAK,IAAM,QAAQ,IAAI,MAAM,MAAM,GAAG;EACpC,IAAM,YAAY,KAAK,QAAQ,GAAG;EAC9B,mBAAa,IACjB,IAAI;GACF,QAAQ,OAAO,KAAK,MAAM,GAAG,SAAS,CAAC,CAAC,KAAK,GAAG,KAAK,MAAM,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC;EAClF,QAAQ,CAGR;CACF;CACA,OAAO;AACT"}