@sanity/client 8.4.0 → 8.6.0

package/dist/index.js

@@ -1,8 +1,9 @@
 import { t as __exportAll } from "./rolldown-runtime-vyAXikos.js";
-import { a as ServerError, c as isHttpError, i as CorsOriginError, l as isQueryParseError, o as formatQueryParseError, r as ClientError, t as defineRequester, u as _defineProperty } from "./request-BhMuKj0D.js";
+import { a as ServerError, c as isHttpError, i as CorsOriginError, l as isQueryParseError, o as formatQueryParseError, r as ClientError, t as defineRequester, u as _defineProperty } from "./request-SY_xwBuz.js";
 import { t as isRecord } from "./isRecord-Kfmt-nk-.js";
 import { _ as validateDocumentId, a as printCreateVersionWithBaseIdWarning, b as validateVersionIdMatch, c as printPreviewDraftsDeprecationWarning, d as requestTag, f as requireDocumentId, g as validateAssetType, h as resourceGuard, i as printCdnPreviewDraftsWarning, l as dataset, m as resourceConfig, n as initConfig, o as printDeprecatedUriOptionWarning, p as requireDocumentType, r as validateApiPerspective, s as printNoDefaultExport, t as defaultConfig, u as hasDataset, v as validateInsert, y as validateObject } from "./config-CgJ16jET.js";
-import { t as stegaClean } from "./stegaClean-C18wLWau.js";
+import { t as stegaClean } from "./stegaClean-YZRATV86.js";
+import { anySignal } from "any-signal";
 import { isTimeoutError } from "get-it";
 import { Observable, catchError, concat, defer, finalize, isObservable, lastValueFrom, map, merge, mergeMap, of, share, tap, throwError, timer } from "rxjs";
 import { getDraftId, getPublishedId, getVersionFromId, getVersionId, isDraftId, isVersionId } from "@sanity/client/csm";
@@ -627,7 +628,7 @@ function _fetch$2(client, httpRequest, _stega, query, _params = {}, options = {}
 		query,
 		params
 	}, reqOpts);
-	return stega.enabled ? Promise.all([request, import("./stegaEncodeSourceMap-YR3NQ3iz.js").then((n) => n.n)]).then(([res, { stegaEncodeSourceMap }]) => {
+	return stega.enabled ? Promise.all([request, import("./stegaEncodeSourceMap-Dj29aWKG.js").then((n) => n.n)]).then(([res, { stegaEncodeSourceMap }]) => {
 		let result = stegaEncodeSourceMap(res.result, res.resultSourceMap, stega);
 		return mapResponse({
 			...res,
@@ -1080,7 +1081,7 @@ function _prepareRequest(client, options) {
 function _observe(userSignal, run) {
 	return new Observable((subscriber) => {
 		let controller = new AbortController();
-		return run(userSignal ? AbortSignal.any([userSignal, controller.signal]) : controller.signal).then((value) => {
+		return run(userSignal ? anySignal([userSignal, controller.signal]) : controller.signal).then((value) => {
 			subscriber.next(value), subscriber.complete();
 		}, (err) => subscriber.error(err)), () => controller.abort();
 	});
@@ -1369,7 +1370,7 @@ function _upload(client, _httpRequest, assetType, body, opts = {}) {
 		body
 	};
 	return typeof XMLHttpRequest < "u" ? defer(async () => {
-		let { uploadWithProgress } = await import("./browserUpload-D-2Rmfjo.js"), req = _prepareRequest(client, { ...baseRequest });
+		let { uploadWithProgress } = await import("./browserUpload-CXcfRh-z.js"), req = _prepareRequest(client, { ...baseRequest });
 		return uploadWithProgress({
 			url: appendQuery(req.url, req.query),
 			method: req.method ?? "POST",
@@ -3684,7 +3685,79 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	}
 }, _clientConfig = /* @__PURE__ */ new WeakMap(), _httpRequest = /* @__PURE__ */ new WeakMap(), ObservableSanityClient = class ObservableSanityClient {
 	constructor(httpRequest, config = defaultConfig) {
-		_defineProperty(this, "assets", void 0), _defineProperty(this, "datasets", void 0), _defineProperty(this, "live", void 0), _defineProperty(this, "mediaLibrary", void 0), _defineProperty(this, "projects", void 0), _defineProperty(this, "users", void 0), _defineProperty(this, "agent", void 0), _defineProperty(this, "collaboration", void 0), _defineProperty(this, "functions", void 0), _defineProperty(this, "releases", void 0), _defineProperty(
+		_defineProperty(
+			this,
+			/**
+			* Upload, fetch and delete assets (images and files) in the configured dataset
+			*
+			* @category Assets
+			*/
+			"assets",
+			void 0
+		), _defineProperty(
+			this,
+			/**
+			* Create, list, edit and delete datasets in the configured project
+			*
+			* @category Projects & Datasets
+			*/
+			"datasets",
+			void 0
+		), _defineProperty(
+			this,
+			/**
+			* Subscribe to live content updates through the Live Content API
+			*
+			* @category Real-time
+			*/
+			"live",
+			void 0
+		), _defineProperty(
+			this,
+			/**
+			* Interact with Media Library assets
+			*
+			* @category Assets
+			*/
+			"mediaLibrary",
+			void 0
+		), _defineProperty(
+			this,
+			/**
+			* Fetch information about the projects the authenticated user has access to
+			*
+			* @category Projects & Datasets
+			*/
+			"projects",
+			void 0
+		), _defineProperty(
+			this,
+			/**
+			* Fetch information about users in the configured project
+			*
+			* @category Projects & Datasets
+			*/
+			"users",
+			void 0
+		), _defineProperty(
+			this,
+			/**
+			* Run Agent Actions - AI-powered operations to generate, transform, translate, prompt and patch documents
+			*
+			* @category Agent Actions
+			*/
+			"agent",
+			void 0
+		), _defineProperty(this, "collaboration", void 0), _defineProperty(this, "functions", void 0), _defineProperty(
+			this,
+			/**
+			* Create and manage content releases and their scheduled publishing
+			*
+			* @category Releases
+			*/
+			"releases",
+			void 0
+		), _defineProperty(
 			this,
 			/** @beta */
 			"context",
@@ -3692,7 +3765,9 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 		), _classPrivateFieldInitSpec(this, _clientConfig, void 0), _classPrivateFieldInitSpec(this, _httpRequest, void 0), _defineProperty(
 			this,
 			/**
-			* Instance properties
+			* Listen to document changes matching a GROQ query, delivered as server-sent events
+			*
+			* @category Real-time
 			*/
 			"listen",
 			_listen$2
@@ -3700,6 +3775,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	}
 	/**
 	* Clone the client - returns a new instance
+	*
+	* @category Configuration
 	*/
 	clone() {
 		return new ObservableSanityClient(_classPrivateFieldGet2(_httpRequest, this), this.config());
@@ -3712,6 +3789,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	/**
 	* Clone the client with a new (partial) configuration.
 	*
+	* @category Configuration
+	*
 	* @param newConfig - New client configuration properties, shallowly merged with existing configuration
 	*/
 	withConfig(newConfig) {
@@ -3747,6 +3826,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	* The order/position of documents is preserved based on the original array of IDs.
 	* If any of the documents are missing, they will be replaced by a `null` entry in the returned array
 	*
+	* @category Querying
+	*
 	* @param ids - Document IDs to fetch
 	* @param options - Request options
 	*/
@@ -3757,6 +3838,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	* Convenient and bandwidth efficient method of checking wether a set of document IDs exists.
 	* Returns a set of the IDs that exist.
 	*
+	* @category Querying
+	*
 	* @param ids - Document IDs to check
 	* @param options - Request options
 	*/
@@ -3796,6 +3879,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	* * Discarding a version with no `releaseId` will discard the draft version of the published document.
 	* * If the draft or release version does not exist, any error will throw.
 	*
+	* @category Versions
+	*
 	* @param params - Version action parameters:
 	*   - `releaseId` - The ID of the release to discard the document from.
 	*   - `publishedId` - The published ID of the document to discard.
@@ -3839,6 +3924,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	* @remarks
 	* * If the published document does not exist, an error will be thrown.
 	*
+	* @category Versions
+	*
 	* @param params - Version action parameters:
 	*   - `releaseId` - The ID of the release to unpublish the document from.
 	*   - `publishedId` - The published ID of the document to unpublish.
@@ -3871,6 +3958,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	/**
 	* Create a new transaction of mutations
 	*
+	* @category Mutations
+	*
 	* @param operations - Optional array of mutation operations to initialize the transaction instance with
 	*/
 	transaction(operations) {
@@ -3879,6 +3968,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	/**
 	* Perform action operations against the configured dataset
 	*
+	* @category Mutations
+	*
 	* @param operations - Action operation(s) to execute
 	* @param options - Action options
 	*/
@@ -3888,6 +3979,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	/**
 	* Perform an HTTP request against the Sanity API
 	*
+	* @category HTTP
+	*
 	* @param options - Request options
 	*/
 	request(options) {
@@ -3896,6 +3989,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	/**
 	* Get a Sanity API URL for the URI provided
 	*
+	* @category HTTP
+	*
 	* @param uri - URI/path to build URL for
 	* @param canUseCdn - Whether or not to allow using the API CDN for this route
 	*/
@@ -3905,6 +4000,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	/**
 	* Get a Sanity API URL for the data operation and path provided
 	*
+	* @category HTTP
+	*
 	* @param operation - Data operation (eg `query`, `mutate`, `listen` or similar)
 	* @param path - Path to append after the operation
 	*/
@@ -3913,7 +4010,79 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	}
 }, _clientConfig2 = /* @__PURE__ */ new WeakMap(), _httpRequest2 = /* @__PURE__ */ new WeakMap(), SanityClient = class SanityClient {
 	constructor(httpRequest, config = defaultConfig) {
-		_defineProperty(this, "assets", void 0), _defineProperty(this, "datasets", void 0), _defineProperty(this, "live", void 0), _defineProperty(this, "mediaLibrary", void 0), _defineProperty(this, "projects", void 0), _defineProperty(this, "users", void 0), _defineProperty(this, "agent", void 0), _defineProperty(this, "collaboration", void 0), _defineProperty(this, "functions", void 0), _defineProperty(this, "releases", void 0), _defineProperty(
+		_defineProperty(
+			this,
+			/**
+			* Upload, fetch and delete assets (images and files) in the configured dataset
+			*
+			* @category Assets
+			*/
+			"assets",
+			void 0
+		), _defineProperty(
+			this,
+			/**
+			* Create, list, edit and delete datasets in the configured project
+			*
+			* @category Projects & Datasets
+			*/
+			"datasets",
+			void 0
+		), _defineProperty(
+			this,
+			/**
+			* Subscribe to live content updates through the Live Content API
+			*
+			* @category Real-time
+			*/
+			"live",
+			void 0
+		), _defineProperty(
+			this,
+			/**
+			* Interact with Media Library assets
+			*
+			* @category Assets
+			*/
+			"mediaLibrary",
+			void 0
+		), _defineProperty(
+			this,
+			/**
+			* Fetch information about the projects the authenticated user has access to
+			*
+			* @category Projects & Datasets
+			*/
+			"projects",
+			void 0
+		), _defineProperty(
+			this,
+			/**
+			* Fetch information about users in the configured project
+			*
+			* @category Projects & Datasets
+			*/
+			"users",
+			void 0
+		), _defineProperty(
+			this,
+			/**
+			* Run Agent Actions - AI-powered operations to generate, transform, translate, prompt and patch documents
+			*
+			* @category Agent Actions
+			*/
+			"agent",
+			void 0
+		), _defineProperty(this, "collaboration", void 0), _defineProperty(this, "functions", void 0), _defineProperty(
+			this,
+			/**
+			* Create and manage content releases and their scheduled publishing
+			*
+			* @category Releases
+			*/
+			"releases",
+			void 0
+		), _defineProperty(
 			this,
 			/** @beta */
 			"context",
@@ -3922,13 +4091,17 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 			this,
 			/**
 			* Observable version of the Sanity client, with the same configuration as the promise-based one
+			*
+			* @category Configuration
 			*/
 			"observable",
 			void 0
 		), _classPrivateFieldInitSpec(this, _clientConfig2, void 0), _classPrivateFieldInitSpec(this, _httpRequest2, void 0), _defineProperty(
 			this,
 			/**
-			* Instance properties
+			* Listen to document changes matching a GROQ query, delivered as server-sent events
+			*
+			* @category Real-time
 			*/
 			"listen",
 			_listen$2
@@ -3936,6 +4109,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	}
 	/**
 	* Clone the client - returns a new instance
+	*
+	* @category Configuration
 	*/
 	clone() {
 		return new SanityClient(_classPrivateFieldGet2(_httpRequest2, this), this.config());
@@ -3948,6 +4123,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	/**
 	* Clone the client with a new (partial) configuration.
 	*
+	* @category Configuration
+	*
 	* @param newConfig - New client configuration properties, shallowly merged with existing configuration
 	*/
 	withConfig(newConfig) {
@@ -3983,6 +4160,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	* The order/position of documents is preserved based on the original array of IDs.
 	* If any of the documents are missing, they will be replaced by a `null` entry in the returned array
 	*
+	* @category Querying
+	*
 	* @param ids - Document IDs to fetch
 	* @param options - Request options
 	*/
@@ -3993,6 +4172,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	* Convenient and bandwidth efficient method of checking wether a set of document IDs exists.
 	* Returns a set of the IDs that exist.
 	*
+	* @category Querying
+	*
 	* @param ids - Document IDs to check
 	* @param options - Request options
 	*/
@@ -4032,6 +4213,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	* * Discarding a version with no `releaseId` will discard the draft version of the published document.
 	* * If the draft or release version does not exist, any error will throw.
 	*
+	* @category Versions
+	*
 	* @param params - Version action parameters:
 	*   - `releaseId` - The ID of the release to discard the document from.
 	*   - `publishedId` - The published ID of the document to discard.
@@ -4075,6 +4258,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	* @remarks
 	* * If the published document does not exist, an error will be thrown.
 	*
+	* @category Versions
+	*
 	* @param params - Version action parameters:
 	*   - `releaseId` - The ID of the release to unpublish the document from.
 	*   - `publishedId` - The published ID of the document to unpublish.
@@ -4107,6 +4292,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	/**
 	* Create a new transaction of mutations
 	*
+	* @category Mutations
+	*
 	* @param operations - Optional array of mutation operations to initialize the transaction instance with
 	*/
 	transaction(operations) {
@@ -4116,6 +4303,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	* Perform action operations against the configured dataset
 	* Returns a promise that resolves to the transaction result
 	*
+	* @category Mutations
+	*
 	* @param operations - Action operation(s) to execute
 	* @param options - Action options
 	*/
@@ -4126,6 +4315,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	* Perform a request against the Sanity API
 	* NOTE: Only use this for Sanity API endpoints, not for your own APIs!
 	*
+	* @category HTTP
+	*
 	* @param options - Request options
 	* @returns Promise resolving to the response body
 	*/
@@ -4148,6 +4339,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	/**
 	* Get a Sanity API URL for the URI provided
 	*
+	* @category HTTP
+	*
 	* @param uri - URI/path to build URL for
 	* @param canUseCdn - Whether or not to allow using the API CDN for this route
 	*/
@@ -4157,6 +4350,8 @@ var _client$1 = /* @__PURE__ */ new WeakMap(), _httpRequest$2 = /* @__PURE__ */
 	/**
 	* Get a Sanity API URL for the data operation and path provided
 	*
+	* @category HTTP
+	*
 	* @param operation - Data operation (eg `query`, `mutate`, `listen` or similar)
 	* @param path - Path to append after the operation
 	*/