@sanity/client 8.1.0 → 8.2.0

package/dist/index.node.js

@@ -726,7 +726,7 @@ function _fetchRequest(_stega, _params, options) {
 }
 /** @internal */
 function _fetchObservable(client, httpRequest, _stega, query, _params = {}, options = {}) {
-	return _observe(options.signal, (signal) => _fetch(client, httpRequest, _stega, query, _params, {
+	return _observe(options.signal, (signal) => _fetch$1(client, httpRequest, _stega, query, _params, {
 		...options,
 		signal
 	}));
@@ -736,7 +736,7 @@ function _fetchObservable(client, httpRequest, _stega, query, _params = {}, opti
 *
 * @internal
 */
-function _fetch(client, httpRequest, _stega, query, _params = {}, options = {}) {
+function _fetch$1(client, httpRequest, _stega, query, _params = {}, options = {}) {
 	let { stega, params, mapResponse, reqOpts } = _fetchRequest(_stega, _params, options), request = _dataRequest(client, httpRequest, "query", {
 		query,
 		params
@@ -889,7 +889,7 @@ function _createVersionFromBaseObservable(client, httpRequest, publishedId, base
 }
 /** @internal */
 function _deleteObservable(client, httpRequest, selection, options) {
-	return _observe(options?.signal, (signal) => _delete(client, httpRequest, selection, {
+	return _observe(options?.signal, (signal) => _delete$1(client, httpRequest, selection, {
 		...options,
 		signal
 	}));
@@ -994,7 +994,7 @@ function _dataRequest(client, httpRequest, endpoint, body, options = {}) {
 * @internal
 */
 function _createObservable(client, httpRequest, doc, op, options = {}) {
-	return _observe(options.signal, (signal) => _create(client, httpRequest, doc, op, {
+	return _observe(options.signal, (signal) => _create$1(client, httpRequest, doc, op, {
 		...options,
 		signal
 	}));
@@ -1004,7 +1004,7 @@ function _createObservable(client, httpRequest, doc, op, options = {}) {
 *
 * @internal
 */
-function _create(client, httpRequest, doc, op, options = {}) {
+function _create$1(client, httpRequest, doc, op, options = {}) {
 	let mutation = { [op]: doc }, opts = Object.assign({
 		returnFirst: !0,
 		returnDocuments: !0
@@ -1041,7 +1041,7 @@ function _mutate(client, httpRequest, mutations, options) {
 *
 * @internal
 */
-function _delete(client, httpRequest, selection, options) {
+function _delete$1(client, httpRequest, selection, options) {
 	return _dataRequest(client, httpRequest, "mutate", { mutations: [{ delete: getSelection(selection) }] }, options);
 }
 /**
@@ -1050,7 +1050,7 @@ function _delete(client, httpRequest, selection, options) {
 * @internal
 */
 function _createIfNotExists(client, httpRequest, doc, options) {
-	return requireDocumentId("createIfNotExists", doc), _create(client, httpRequest, doc, "createIfNotExists", options);
+	return requireDocumentId("createIfNotExists", doc), _create$1(client, httpRequest, doc, "createIfNotExists", options);
 }
 /**
 * Promise-based sibling of {@link _createOrReplaceObservable}.
@@ -1058,7 +1058,7 @@ function _createIfNotExists(client, httpRequest, doc, options) {
 * @internal
 */
 function _createOrReplace(client, httpRequest, doc, options) {
-	return requireDocumentId("createOrReplace", doc), _create(client, httpRequest, doc, "createOrReplace", options);
+	return requireDocumentId("createOrReplace", doc), _create$1(client, httpRequest, doc, "createOrReplace", options);
 }
 /**
 * Promise-based sibling of {@link _createVersionObservable}.
@@ -1589,6 +1589,7 @@ function resolveEventSourceFetch(config, options = {}) {
 function pickBaseFetch(config) {
 	return config.resolveFetch ? config.resolveFetch(typeof config.proxy == "string" ? config.proxy : void 0) : globalThis.fetch.bind(globalThis);
 }
+/** @internal */
 const possibleOptions = [
 	"includePreviousRevision",
 	"includeResult",
@@ -1600,8 +1601,8 @@ const possibleOptions = [
 	"tag"
 ], defaultOptions = { includeResult: !0 };
 /** @public */
-function _listen(query, params, opts = {}) {
-	let config = this.config(), { url, token, withCredentials, requestTagPrefix, headers: configHeaders } = config, tag = opts.tag && requestTagPrefix ? [requestTagPrefix, opts.tag].join(".") : opts.tag, options = {
+function _listen$1(query, params, opts = {}) {
+	let { url, requestTagPrefix } = this.config(), tag = opts.tag && requestTagPrefix ? [requestTagPrefix, opts.tag].join(".") : opts.tag, options = {
 		...defaults_default(opts, defaultOptions),
 		tag
 	}, listenOpts = pick(options, possibleOptions), qs = encodeQueryString({
@@ -1613,7 +1614,12 @@ function _listen(query, params, opts = {}) {
 		}
 	}), uri = `${url}${_getDataUrl(this, "listen", qs)}`;
 	if (uri.length > 14800) return throwError(() => /* @__PURE__ */ Error("Query too large for listener"));
-	let listenFor = options.events ? options.events : ["mutation"], headers = {};
+	let listenFor = options.events ? options.events : ["mutation"];
+	return _connectListenEventSource(this, uri, listenFor);
+}
+/** @internal */
+function _connectListenEventSource(client, uri, listenFor) {
+	let config = client.config(), { token, withCredentials, headers: configHeaders } = config, headers = {};
 	token && (headers.Authorization = `Bearer ${token}`), configHeaders && Object.assign(headers, configHeaders);
 	let initEventSource = () => new EventSource(uri, { fetch: resolveEventSourceFetch(config, {
 		headers: Object.keys(headers).length ? headers : void 0,
@@ -1624,6 +1630,358 @@ function _listen(query, params, opts = {}) {
 		..."data" in event ? event.data : {}
 	})));
 }
+/** @internal */
+const possibleRequestOptions = [
+	"headers",
+	"signal",
+	"tag",
+	"timeout",
+	"token"
+];
+function commentUrl(id) {
+	if (!id) throw Error("Comment ID must be provided");
+	return `/collaboration/comments/${encodeURIComponent(id)}`;
+}
+function resolveCommentResource(client) {
+	let { resource, projectId, dataset } = client.config();
+	if (resource) return resource;
+	if (projectId && dataset) return {
+		type: "dataset",
+		id: `${projectId}.${dataset}`
+	};
+	throw Error("`resource` or `projectId` and `dataset` must be configured to use collaboration comments");
+}
+function resourceQuery(client) {
+	let { collaboration } = client.config(), organizationId = collaboration?.organizationId;
+	if (!organizationId) throw Error("`collaboration.organizationId` must be configured to use collaboration comments");
+	let resource = resolveCommentResource(client);
+	return {
+		organizationId,
+		resourceId: resource.id,
+		resourceType: resource.type
+	};
+}
+/** @internal */
+function _getTargetDocumentRef(client, documentId) {
+	if (!documentId) throw Error("Document ID must be provided");
+	let resource = resolveCommentResource(client);
+	return `${resource.type}:${resource.id}:${getPublishedId(documentId)}`;
+}
+function write(client, httpRequest, method, url, body, options = {}) {
+	return _requestObservable(client, httpRequest, {
+		method,
+		url,
+		body,
+		query: {
+			...resourceQuery(client),
+			...options.transactionId ? { transactionId: options.transactionId } : {}
+		},
+		...pick(options, possibleRequestOptions)
+	});
+}
+/**
+* `commentId` picks the written comment out of the results: a status update
+* cascades to the comment's replies, and the API leaves the results unordered.
+* Creates pass the requested `_id`, which is undefined when the API assigns
+* one, and always come back with a single result.
+*/
+function writeDocument(commentId, ...args) {
+	return write(...args).pipe(map$1(({ results }) => {
+		let result = commentId ? results.find(({ id }) => id === commentId) : results[0];
+		if (!result?.document) throw Error("Comment write did not return a comment document");
+		return result.document;
+	}));
+}
+function writeMutationResult(...args) {
+	return write(...args).pipe(map$1(({ transactionId, results }) => ({
+		transactionId,
+		documentIds: results.map((result) => result.id),
+		results
+	})));
+}
+/** @internal */
+function _create(client, httpRequest, body, options) {
+	return writeDocument(body._id, client, httpRequest, "POST", "/collaboration/comments", body, options);
+}
+/** @internal */
+function _update(client, httpRequest, id, body, options) {
+	return writeDocument(id, client, httpRequest, "PATCH", commentUrl(id), body, options);
+}
+/** @internal */
+function _delete(client, httpRequest, id, options) {
+	return writeMutationResult(client, httpRequest, "DELETE", commentUrl(id), void 0, options);
+}
+/** @internal */
+function _addReaction(client, httpRequest, id, shortName, options) {
+	return writeDocument(id, client, httpRequest, "POST", `${commentUrl(id)}/reactions`, { shortName }, options);
+}
+/** @internal */
+function _removeReaction(client, httpRequest, id, shortName, options) {
+	return writeDocument(id, client, httpRequest, "DELETE", `${commentUrl(id)}/reactions/${encodeURIComponent(shortName)}`, void 0, options);
+}
+/** @internal */
+function _fetch(client, httpRequest, query, params, options) {
+	let search = resourceQuery(client);
+	return _requestObservable(client, httpRequest, {
+		...encodeQueryString({
+			query,
+			params
+		}).length < 11264 ? {
+			method: "GET",
+			url: `/collaboration/comments/query${encodeQueryString({
+				query,
+				params,
+				options: search
+			})}`
+		} : {
+			method: "POST",
+			url: "/collaboration/comments/query",
+			query: search,
+			body: {
+				query,
+				params: params ?? {}
+			}
+		},
+		...pick(options || {}, possibleRequestOptions)
+	}).pipe(map$1((response) => response.result));
+}
+/** @internal */
+function _listen(client, query, params, options) {
+	let opts = options ?? {}, { requestTagPrefix } = client.config(), tag = opts.tag && requestTagPrefix ? [requestTagPrefix, opts.tag].join(".") : opts.tag, listenOpts = pick({
+		...defaults_default(opts, defaultOptions),
+		tag
+	}, possibleOptions), qs = encodeQueryString({
+		query,
+		params,
+		options: {
+			...listenOpts,
+			...resourceQuery(client)
+		}
+	}), uri = `${client.getUrl("/collaboration/comments/listen")}${qs}`;
+	return uri.length > 14800 ? throwError(() => /* @__PURE__ */ Error("Query too large for listener")) : _connectListenEventSource(client, uri, opts.events ? opts.events : ["mutation"]);
+}
+/**
+* Comments on the configured organization resource.
+*
+* Requires `collaboration.organizationId`, plus either `resource` or `projectId` and `dataset`.
+*
+* @alpha
+*/
+var ObservableCollaborationCommentsClient = class {
+	#client;
+	#httpRequest;
+	constructor(client, httpRequest) {
+		this.#client = client, this.#httpRequest = httpRequest;
+	}
+	/**
+	* Create a comment or reply on the configured resource.
+	*
+	* A top-level comment requires `target`; a reply requires `parentCommentId` (never both).
+	* Replies inherit `target`, `status`, and `threadId` from the parent comment.
+	*
+	* @param body - Comment to create
+	* @param options - Optional request options
+	* @returns The created comment
+	*/
+	create(body, options) {
+		return _create(this.#client, this.#httpRequest, body, options);
+	}
+	/**
+	* Update an existing comment.
+	*
+	* Updating `status` cascades to the comment's replies.
+	*
+	* @param id - Comment document ID
+	* @param body - Fields to update
+	* @param options - Optional request options
+	* @returns The updated comment
+	*/
+	update(id, body, options) {
+		return _update(this.#client, this.#httpRequest, id, body, options);
+	}
+	/**
+	* Delete a comment and its replies.
+	*
+	* @param id - Comment document ID
+	* @param options - Optional request options
+	* @returns Mutation result, where `documentIds` covers the comment and every deleted reply
+	*/
+	delete(id, options) {
+		return _delete(this.#client, this.#httpRequest, id, options);
+	}
+	/**
+	* Add the current user's reaction to a comment.
+	*
+	* @param id - Comment document ID
+	* @param shortName - Emoji short name, for example `:+1:`
+	* @param options - Optional request options
+	* @returns The comment, with the reaction applied
+	*/
+	addReaction(id, shortName, options) {
+		return _addReaction(this.#client, this.#httpRequest, id, shortName, options);
+	}
+	/**
+	* Remove the current user's reaction from a comment.
+	*
+	* @param id - Comment document ID
+	* @param shortName - Emoji short name, for example `:+1:`
+	* @param options - Optional request options
+	* @returns The comment, with the reaction removed
+	*/
+	removeReaction(id, shortName, options) {
+		return _removeReaction(this.#client, this.#httpRequest, id, shortName, options);
+	}
+	/**
+	* Build the global document reference used by `target.document._ref`, for use in
+	* queries and listeners.
+	*
+	* The reference is built from the configured `resource` and the published ID of
+	* the given document ID, since comment references always use published IDs.
+	*
+	* @example
+	* ```ts
+	* client.collaboration.comments.listen(
+	*   '*[_type == "sanity.comment" && target.document._ref == $ref]',
+	*   {ref: client.collaboration.comments.getTargetDocumentRef('doc-1')},
+	* )
+	* ```
+	*
+	* @param documentId - Document ID, in published, draft or version form
+	* @returns Global document reference, of the form `resourceType:resourceId:documentId`
+	*/
+	getTargetDocumentRef(documentId) {
+		return _getTargetDocumentRef(this.#client, documentId);
+	}
+	/**
+	* Fetch comments on the configured resource.
+	*
+	* Takes the same `query` and `params` as `client.fetch`, and switches from a
+	* GET to a POST for queries too large for the request URL in the same way,
+	* but queries the comments endpoint, which accepts none of the query options
+	* `client.fetch` does (`perspective`, `useCdn`, `filterResponse`,
+	* `resultSourceMap`, stega).
+	*
+	* The query runs against the organization store, which is not scoped to
+	* comments, so filter on `_type == "sanity.comment"`.
+	*
+	* @param query - GROQ-query to perform
+	* @param params - Optional query parameters
+	* @param options - Optional request options
+	*/
+	fetch(query, params, options) {
+		return _fetch(this.#client, this.#httpRequest, query, params, options);
+	}
+	listen(query, params, options) {
+		return _listen(this.#client, query, params, options);
+	}
+}, CollaborationCommentsClient = class {
+	#client;
+	#httpRequest;
+	constructor(client, httpRequest) {
+		this.#client = client, this.#httpRequest = httpRequest;
+	}
+	/**
+	* Create a comment or reply on the configured resource.
+	*
+	* A top-level comment requires `target`; a reply requires `parentCommentId` (never both).
+	* Replies inherit `target`, `status`, and `threadId` from the parent comment.
+	*
+	* @param body - Comment to create
+	* @param options - Optional request options
+	* @returns The created comment
+	*/
+	create(body, options) {
+		return lastValueFrom(_create(this.#client, this.#httpRequest, body, options));
+	}
+	/**
+	* Update an existing comment.
+	*
+	* Updating `status` cascades to the comment's replies.
+	*
+	* @param id - Comment document ID
+	* @param body - Fields to update
+	* @param options - Optional request options
+	* @returns The updated comment
+	*/
+	update(id, body, options) {
+		return lastValueFrom(_update(this.#client, this.#httpRequest, id, body, options));
+	}
+	/**
+	* Delete a comment and its replies.
+	*
+	* @param id - Comment document ID
+	* @param options - Optional request options
+	* @returns Mutation result, where `documentIds` covers the comment and every deleted reply
+	*/
+	delete(id, options) {
+		return lastValueFrom(_delete(this.#client, this.#httpRequest, id, options));
+	}
+	/**
+	* Add the current user's reaction to a comment.
+	*
+	* @param id - Comment document ID
+	* @param shortName - Emoji short name, for example `:+1:`
+	* @param options - Optional request options
+	* @returns The comment, with the reaction applied
+	*/
+	addReaction(id, shortName, options) {
+		return lastValueFrom(_addReaction(this.#client, this.#httpRequest, id, shortName, options));
+	}
+	/**
+	* Remove the current user's reaction from a comment.
+	*
+	* @param id - Comment document ID
+	* @param shortName - Emoji short name, for example `:+1:`
+	* @param options - Optional request options
+	* @returns The comment, with the reaction removed
+	*/
+	removeReaction(id, shortName, options) {
+		return lastValueFrom(_removeReaction(this.#client, this.#httpRequest, id, shortName, options));
+	}
+	/**
+	* Build the global document reference used by `target.document._ref`, for use in
+	* queries and listeners.
+	*
+	* The reference is built from the configured `resource` and the published ID of
+	* the given document ID, since comment references always use published IDs.
+	*
+	* @example
+	* ```ts
+	* const comments = await client.collaboration.comments.fetch(
+	*   '*[_type == "sanity.comment" && target.document._ref == $ref]',
+	*   {ref: client.collaboration.comments.getTargetDocumentRef('doc-1')},
+	* )
+	* ```
+	*
+	* @param documentId - Document ID, in published, draft or version form
+	* @returns Global document reference, of the form `resourceType:resourceId:documentId`
+	*/
+	getTargetDocumentRef(documentId) {
+		return _getTargetDocumentRef(this.#client, documentId);
+	}
+	/**
+	* Fetch comments on the configured resource.
+	*
+	* Takes the same `query` and `params` as `client.fetch`, and switches from a
+	* GET to a POST for queries too large for the request URL in the same way,
+	* but queries the comments endpoint, which accepts none of the query options
+	* `client.fetch` does (`perspective`, `useCdn`, `filterResponse`,
+	* `resultSourceMap`, stega).
+	*
+	* The query runs against the organization store, which is not scoped to
+	* comments, so filter on `_type == "sanity.comment"`.
+	*
+	* @param query - GROQ-query to perform
+	* @param params - Optional query parameters
+	* @param options - Optional request options
+	*/
+	fetch(query, params, options) {
+		return lastValueFrom(_fetch(this.#client, this.#httpRequest, query, params, options));
+	}
+	listen(query, params, options) {
+		return _listen(this.#client, query, params, options);
+	}
+};
 /**
 * A variant of share that takes a predicate function to determine which value to replay to new subscribers
 * @param configOrPredicate - Predicate function to determine which value to replay
@@ -2689,6 +3047,7 @@ var ObservableReleasesClient = class {
 	projects;
 	users;
 	agent;
+	collaboration;
 	functions;
 	releases;
 	/**
@@ -2699,9 +3058,9 @@ var ObservableReleasesClient = class {
 	/**
 	* Instance properties
 	*/
-	listen = _listen;
+	listen = _listen$1;
 	constructor(httpRequest, config = defaultConfig) {
-		this.config(config), this.#httpRequest = httpRequest, this.assets = new ObservableAssetsClient(this, this.#httpRequest), this.datasets = new ObservableDatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.mediaLibrary = { video: new ObservableMediaLibraryVideoClient(this, this.#httpRequest) }, this.projects = new ObservableProjectsClient(this, this.#httpRequest), this.users = new ObservableUsersClient(this, this.#httpRequest), this.agent = { action: new ObservableAgentsActionClient(this, this.#httpRequest) }, this.functions = new ObservableFunctionsClient(this, this.#httpRequest), this.releases = new ObservableReleasesClient(this, this.#httpRequest);
+		this.config(config), this.#httpRequest = httpRequest, this.assets = new ObservableAssetsClient(this, this.#httpRequest), this.datasets = new ObservableDatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.mediaLibrary = { video: new ObservableMediaLibraryVideoClient(this, this.#httpRequest) }, this.projects = new ObservableProjectsClient(this, this.#httpRequest), this.users = new ObservableUsersClient(this, this.#httpRequest), this.agent = { action: new ObservableAgentsActionClient(this, this.#httpRequest) }, this.collaboration = { comments: new ObservableCollaborationCommentsClient(this, this.#httpRequest) }, this.functions = new ObservableFunctionsClient(this, this.#httpRequest), this.releases = new ObservableReleasesClient(this, this.#httpRequest);
 	}
 	/**
 	* Clone the client - returns a new instance
@@ -2924,6 +3283,7 @@ var ObservableReleasesClient = class {
 	projects;
 	users;
 	agent;
+	collaboration;
 	functions;
 	releases;
 	/**
@@ -2938,9 +3298,9 @@ var ObservableReleasesClient = class {
 	/**
 	* Instance properties
 	*/
-	listen = _listen;
+	listen = _listen$1;
 	constructor(httpRequest, config = defaultConfig) {
-		this.config(config), this.#httpRequest = httpRequest, this.assets = new AssetsClient(this, this.#httpRequest), this.datasets = new DatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.mediaLibrary = { video: new MediaLibraryVideoClient(this, this.#httpRequest) }, this.projects = new ProjectsClient(this, this.#httpRequest), this.users = new UsersClient(this, this.#httpRequest), this.agent = { action: new AgentActionsClient(this, this.#httpRequest) }, this.functions = new FunctionsClient(this, this.#httpRequest), this.releases = new ReleasesClient(this, this.#httpRequest), this.observable = new ObservableSanityClient(httpRequest, config);
+		this.config(config), this.#httpRequest = httpRequest, this.assets = new AssetsClient(this, this.#httpRequest), this.datasets = new DatasetsClient(this, this.#httpRequest), this.live = new LiveClient(this), this.mediaLibrary = { video: new MediaLibraryVideoClient(this, this.#httpRequest) }, this.projects = new ProjectsClient(this, this.#httpRequest), this.users = new UsersClient(this, this.#httpRequest), this.agent = { action: new AgentActionsClient(this, this.#httpRequest) }, this.collaboration = { comments: new CollaborationCommentsClient(this, this.#httpRequest) }, this.functions = new FunctionsClient(this, this.#httpRequest), this.releases = new ReleasesClient(this, this.#httpRequest), this.observable = new ObservableSanityClient(httpRequest, config);
 	}
 	/**
 	* Clone the client - returns a new instance
@@ -2970,7 +3330,7 @@ var ObservableReleasesClient = class {
 		});
 	}
 	fetch(query, params, options) {
-		return _fetch(this, this.#httpRequest, this.#clientConfig.stega, query, params, options);
+		return _fetch$1(this, this.#httpRequest, this.#clientConfig.stega, query, params, options);
 	}
 	getDocument(id, options) {
 		if (options?.includeAllVersions === !0) return _getDocument(this, this.#httpRequest, id, {
@@ -3008,7 +3368,7 @@ var ObservableReleasesClient = class {
 		return _documentsExists(this, this.#httpRequest, ids, options);
 	}
 	create(document, options) {
-		return _create(this, this.#httpRequest, document, "create", options);
+		return _create$1(this, this.#httpRequest, document, "create", options);
 	}
 	createIfNotExists(document, options) {
 		return _createIfNotExists(this, this.#httpRequest, document, options);
@@ -3029,7 +3389,7 @@ var ObservableReleasesClient = class {
 		return _createVersion(this, this.#httpRequest, documentVersion, versionPublishedId, options);
 	}
 	delete(selection, options) {
-		return _delete(this, this.#httpRequest, selection, options);
+		return _delete$1(this, this.#httpRequest, selection, options);
 	}
 	/**
 	* @public
@@ -3202,7 +3562,7 @@ function defineDeprecatedCreateClient(createClient) {
 		return printNoDefaultExport(), createClient(config);
 	};
 }
-var name = "@sanity/client", version = "8.1.0";
+var name = "@sanity/client", version = "8.2.0";
 const log = createDebug("sanity:client");
 function isNodeReadableStream(value) {
 	return typeof value != "object" || !value || !("pipe" in value) ? !1 : typeof value.pipe == "function";