@sanity/client 8.4.0 → 8.5.0

package/dist/index.node.js

@@ -1373,7 +1373,10 @@ function _translate(client, httpRequest, request) {
 		body: request
 	});
 }
-/** @public */
+/**
+* @public
+* @inline
+*/
 var ObservableAgentsActionClient = class {
 	#client;
 	#httpRequest;
@@ -2819,6 +2822,7 @@ function _shareReplayLatest(config) {
 const requiredApiVersion = "2021-03-25";
 /**
 * @public
+* @inline
 */
 var LiveClient = class {
 	#client;
@@ -2945,7 +2949,10 @@ function checkCorsObservable(url, projectId, requireCredentials, fetcher) {
 * resolver — `undefined` covers the `globalThis.fetch` fallback.
 */
 const eventsCache = /* @__PURE__ */ new Map();
-/** @internal */
+/**
+* @internal
+* @inline
+*/
 var ObservableDatasetsClient = class {
 	#client;
 	#httpRequest;
@@ -3260,7 +3267,10 @@ function buildQueryParams(options) {
 	}
 	return options.expiration && (params.expiration = options.expiration), params;
 }
-/** @internal */
+/**
+* @internal
+* @inline
+*/
 var ObservableProjectsClient = class {
 	#client;
 	#httpRequest;
@@ -3387,7 +3397,10 @@ const getArgs = (releaseOrOptions, maybeOptions) => {
 		options
 	};
 };
-/** @public */
+/**
+* @public
+* @inline
+*/
 var ObservableReleasesClient = class {
 	#client;
 	#httpRequest;
@@ -3842,25 +3855,64 @@ var ObservableReleasesClient = class {
 		return _request(this.#client, this.#httpRequest, { url: `/users/${id}` });
 	}
 }, ObservableSanityClient = class ObservableSanityClient {
+	/**
+	* Upload, fetch and delete assets (images and files) in the configured dataset
+	*
+	* @category Assets
+	*/
 	assets;
+	/**
+	* Create, list, edit and delete datasets in the configured project
+	*
+	* @category Projects & Datasets
+	*/
 	datasets;
+	/**
+	* Subscribe to live content updates through the Live Content API
+	*
+	* @category Real-time
+	*/
 	live;
+	/**
+	* Interact with Media Library assets
+	*
+	* @category Assets
+	*/
 	mediaLibrary;
+	/**
+	* Fetch information about the projects the authenticated user has access to
+	*
+	* @category Projects & Datasets
+	*/
 	projects;
+	/**
+	* Fetch information about users in the configured project
+	*
+	* @category Projects & Datasets
+	*/
 	users;
+	/**
+	* Run Agent Actions - AI-powered operations to generate, transform, translate, prompt and patch documents
+	*
+	* @category Agent Actions
+	*/
 	agent;
 	collaboration;
 	functions;
+	/**
+	* Create and manage content releases and their scheduled publishing
+	*
+	* @category Releases
+	*/
 	releases;
 	/** @beta */
 	context;
-	/**
-	* Private properties
-	*/
 	#clientConfig;
 	#httpRequest;
 	/**
-	* Instance properties
+	* Listen to document changes matching a GROQ query, delivered as server-sent events
+	*
+	* @category Real-time
 	*/
 	listen = _listen$2;
 	constructor(httpRequest, config = defaultConfig) {
@@ -3868,6 +3920,8 @@ var ObservableReleasesClient = class {
 	}
 	/**
 	* Clone the client - returns a new instance
+	*
+	* @category Configuration
 	*/
 	clone() {
 		return new ObservableSanityClient(this.#httpRequest, this.config());
@@ -3880,6 +3934,8 @@ var ObservableReleasesClient = class {
 	/**
 	* Clone the client with a new (partial) configuration.
 	*
+	* @category Configuration
+	*
 	* @param newConfig - New client configuration properties, shallowly merged with existing configuration
 	*/
 	withConfig(newConfig) {
@@ -3915,6 +3971,8 @@ var ObservableReleasesClient = class {
 	* 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
 	*/
@@ -3925,6 +3983,8 @@ var ObservableReleasesClient = class {
 	* 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
 	*/
@@ -3964,6 +4024,8 @@ var ObservableReleasesClient = class {
 	* * 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.
@@ -4007,6 +4069,8 @@ var ObservableReleasesClient = class {
 	* @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.
@@ -4039,6 +4103,8 @@ var ObservableReleasesClient = class {
 	/**
 	* Create a new transaction of mutations
 	*
+	* @category Mutations
+	*
 	* @param operations - Optional array of mutation operations to initialize the transaction instance with
 	*/
 	transaction(operations) {
@@ -4047,6 +4113,8 @@ var ObservableReleasesClient = class {
 	/**
 	* Perform action operations against the configured dataset
 	*
+	* @category Mutations
+	*
 	* @param operations - Action operation(s) to execute
 	* @param options - Action options
 	*/
@@ -4056,6 +4124,8 @@ var ObservableReleasesClient = class {
 	/**
 	* Perform an HTTP request against the Sanity API
 	*
+	* @category HTTP
+	*
 	* @param options - Request options
 	*/
 	request(options) {
@@ -4064,6 +4134,8 @@ var ObservableReleasesClient = class {
 	/**
 	* 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
 	*/
@@ -4073,6 +4145,8 @@ var ObservableReleasesClient = class {
 	/**
 	* 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
 	*/
@@ -4080,29 +4154,70 @@ var ObservableReleasesClient = class {
 		return _getDataUrl(this, operation, path);
 	}
 }, SanityClient = class SanityClient {
+	/**
+	* Upload, fetch and delete assets (images and files) in the configured dataset
+	*
+	* @category Assets
+	*/
 	assets;
+	/**
+	* Create, list, edit and delete datasets in the configured project
+	*
+	* @category Projects & Datasets
+	*/
 	datasets;
+	/**
+	* Subscribe to live content updates through the Live Content API
+	*
+	* @category Real-time
+	*/
 	live;
+	/**
+	* Interact with Media Library assets
+	*
+	* @category Assets
+	*/
 	mediaLibrary;
+	/**
+	* Fetch information about the projects the authenticated user has access to
+	*
+	* @category Projects & Datasets
+	*/
 	projects;
+	/**
+	* Fetch information about users in the configured project
+	*
+	* @category Projects & Datasets
+	*/
 	users;
+	/**
+	* Run Agent Actions - AI-powered operations to generate, transform, translate, prompt and patch documents
+	*
+	* @category Agent Actions
+	*/
 	agent;
 	collaboration;
 	functions;
+	/**
+	* Create and manage content releases and their scheduled publishing
+	*
+	* @category Releases
+	*/
 	releases;
 	/** @beta */
 	context;
 	/**
 	* Observable version of the Sanity client, with the same configuration as the promise-based one
+	*
+	* @category Configuration
 	*/
 	observable;
-	/**
-	* Private properties
-	*/
 	#clientConfig;
 	#httpRequest;
 	/**
-	* Instance properties
+	* Listen to document changes matching a GROQ query, delivered as server-sent events
+	*
+	* @category Real-time
 	*/
 	listen = _listen$2;
 	constructor(httpRequest, config = defaultConfig) {
@@ -4110,6 +4225,8 @@ var ObservableReleasesClient = class {
 	}
 	/**
 	* Clone the client - returns a new instance
+	*
+	* @category Configuration
 	*/
 	clone() {
 		return new SanityClient(this.#httpRequest, this.config());
@@ -4122,6 +4239,8 @@ var ObservableReleasesClient = class {
 	/**
 	* Clone the client with a new (partial) configuration.
 	*
+	* @category Configuration
+	*
 	* @param newConfig - New client configuration properties, shallowly merged with existing configuration
 	*/
 	withConfig(newConfig) {
@@ -4157,6 +4276,8 @@ var ObservableReleasesClient = class {
 	* 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
 	*/
@@ -4167,6 +4288,8 @@ var ObservableReleasesClient = class {
 	* 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
 	*/
@@ -4206,6 +4329,8 @@ var ObservableReleasesClient = class {
 	* * 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.
@@ -4249,6 +4374,8 @@ var ObservableReleasesClient = class {
 	* @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.
@@ -4281,6 +4408,8 @@ var ObservableReleasesClient = class {
 	/**
 	* Create a new transaction of mutations
 	*
+	* @category Mutations
+	*
 	* @param operations - Optional array of mutation operations to initialize the transaction instance with
 	*/
 	transaction(operations) {
@@ -4290,6 +4419,8 @@ var ObservableReleasesClient = class {
 	* 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
 	*/
@@ -4300,6 +4431,8 @@ var ObservableReleasesClient = class {
 	* 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
 	*/
@@ -4322,6 +4455,8 @@ var ObservableReleasesClient = class {
 	/**
 	* 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
 	*/
@@ -4331,6 +4466,8 @@ var ObservableReleasesClient = class {
 	/**
 	* 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
 	*/
@@ -4368,7 +4505,7 @@ function defineDeprecatedCreateClient(createClient) {
 		return printNoDefaultExport(), createClient(config);
 	};
 }
-var name = "@sanity/client", version = "8.4.0";
+var name = "@sanity/client", version = "8.5.0";
 const log = createDebug("sanity:client");
 function isNodeReadableStream(value) {
 	return typeof value != "object" || !value || !("pipe" in value) ? !1 : typeof value.pipe == "function";