@sanity/client 6.22.2-canary.0 → 6.22.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -919,9 +919,16 @@ export declare class LiveClient {
919
919
  */
920
920
  events({
921
921
  includeDrafts,
922
+ tag: _tag,
922
923
  }?: {
923
924
  /** @alpha this API is experimental and may change or even be removed */
924
925
  includeDrafts?: boolean
926
+ /**
927
+ * Optional request tag for the listener. Use to identify the request in logs.
928
+ *
929
+ * @defaultValue `undefined`
930
+ */
931
+ tag?: string
925
932
  }): Observable<LiveEventMessage | LiveEventRestart | LiveEventReconnect | LiveEventWelcome>
926
933
  }
927
934
 
@@ -919,9 +919,16 @@ export declare class LiveClient {
919
919
  */
920
920
  events({
921
921
  includeDrafts,
922
+ tag: _tag,
922
923
  }?: {
923
924
  /** @alpha this API is experimental and may change or even be removed */
924
925
  includeDrafts?: boolean
926
+ /**
927
+ * Optional request tag for the listener. Use to identify the request in logs.
928
+ *
929
+ * @defaultValue `undefined`
930
+ */
931
+ tag?: string
925
932
  }): Observable<LiveEventMessage | LiveEventRestart | LiveEventReconnect | LiveEventWelcome>
926
933
  }
927
934
 
@@ -927,9 +927,15 @@ class LiveClient {
927
927
  * Requires `apiVersion` to be `2021-03-26` or later.
928
928
  */
929
929
  events({
930
- includeDrafts = !1
930
+ includeDrafts = !1,
931
+ tag: _tag
931
932
  } = {}) {
932
- const { apiVersion: _apiVersion, token, withCredentials } = this.#client.config(), apiVersion = _apiVersion.replace(/^v/, "");
933
+ const {
934
+ apiVersion: _apiVersion,
935
+ token,
936
+ withCredentials,
937
+ requestTagPrefix
938
+ } = this.#client.config(), apiVersion = _apiVersion.replace(/^v/, "");
933
939
  if (apiVersion !== "X" && apiVersion < requiredApiVersion)
934
940
  throw new Error(
935
941
  `The live events API requires API version ${requiredApiVersion} or later. The current API version is ${apiVersion}. Please update your API version to use this feature.`
@@ -942,8 +948,8 @@ class LiveClient {
942
948
  throw new Error(
943
949
  "The live events API requires API version X when 'includeDrafts: true'. This API is experimental and may change or even be removed."
944
950
  );
945
- const path = _getDataUrl(this.#client, "live/events"), url = new URL(this.#client.getUrl(path, !1));
946
- includeDrafts && url.searchParams.set("includeDrafts", "true");
951
+ const path = _getDataUrl(this.#client, "live/events"), url = new URL(this.#client.getUrl(path, !1)), tag = _tag && requestTagPrefix ? [requestTagPrefix, _tag].join(".") : _tag;
952
+ tag && url.searchParams.set("tag", tag), includeDrafts && url.searchParams.set("includeDrafts", "true");
947
953
  const listenFor = ["restart", "message", "welcome", "reconnect"], esOptions = {};
948
954
  return includeDrafts && token && (esOptions.headers = {
949
955
  Authorization: `Bearer ${token}`