@sanity/client 7.21.0 → 7.22.0

package/dist/index.d.cts

@@ -862,6 +862,7 @@ export declare class ClientError extends Error {
   response: ErrorProps['response']
   statusCode: ErrorProps['statusCode']
   responseBody: ErrorProps['responseBody']
+  traceId: ErrorProps['traceId']
   details: ErrorProps['details']
   constructor(res: Any, context?: HttpContext)
 }
@@ -1409,6 +1410,7 @@ export declare interface ErrorProps {
   response: Any
   statusCode: number
   responseBody: Any
+  traceId?: string
   details: Any
 }
 
@@ -1559,7 +1561,11 @@ export declare type FitMode = 'preserve' | 'stretch' | 'crop' | 'smartcrop' | 'p
  * @returns A formatted error message string.
  * @public
  */
-export declare function formatQueryParseError(error: QueryParseError, tag?: string | null): string
+export declare function formatQueryParseError(
+  error: QueryParseError,
+  tag?: string | null,
+  traceId?: string,
+): string
 
 /** @beta */
 declare type GenerateAsyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
@@ -5871,6 +5877,7 @@ export declare class ServerError extends Error {
   response: ErrorProps['response']
   statusCode: ErrorProps['statusCode']
   responseBody: ErrorProps['responseBody']
+  traceId: ErrorProps['traceId']
   details: ErrorProps['details']
   constructor(res: Any)
 }

package/dist/index.d.ts

@@ -862,6 +862,7 @@ export declare class ClientError extends Error {
   response: ErrorProps['response']
   statusCode: ErrorProps['statusCode']
   responseBody: ErrorProps['responseBody']
+  traceId: ErrorProps['traceId']
   details: ErrorProps['details']
   constructor(res: Any, context?: HttpContext)
 }
@@ -1409,6 +1410,7 @@ export declare interface ErrorProps {
   response: Any
   statusCode: number
   responseBody: Any
+  traceId?: string
   details: Any
 }
 
@@ -1559,7 +1561,11 @@ export declare type FitMode = 'preserve' | 'stretch' | 'crop' | 'smartcrop' | 'p
  * @returns A formatted error message string.
  * @public
  */
-export declare function formatQueryParseError(error: QueryParseError, tag?: string | null): string
+export declare function formatQueryParseError(
+  error: QueryParseError,
+  tag?: string | null,
+  traceId?: string,
+): string
 
 /** @beta */
 declare type GenerateAsyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
@@ -5871,6 +5877,7 @@ export declare class ServerError extends Error {
   response: ErrorProps['response']
   statusCode: ErrorProps['statusCode']
   responseBody: ErrorProps['responseBody']
+  traceId: ErrorProps['traceId']
   details: ErrorProps['details']
   constructor(res: Any)
 }

package/dist/index.js

@@ -87,6 +87,7 @@ class ClientError extends Error {
   response;
   statusCode = 400;
   responseBody;
+  traceId;
   details;
   constructor(res, context) {
     const props = extractErrorProps(res, context);
@@ -97,6 +98,7 @@ class ServerError extends Error {
   response;
   statusCode = 500;
   responseBody;
+  traceId;
   details;
   constructor(res) {
     const props = extractErrorProps(res);
@@ -108,29 +110,30 @@ function extractErrorProps(res, context) {
     response: res,
     statusCode: res.statusCode,
     responseBody: stringifyBody(body, res),
+    traceId: extractTraceId(res),
     message: "",
     details: void 0
   };
   if (!isRecord(body))
-    return props.message = httpErrorMessage(res, body), props;
+    return props.message = `${httpErrorMessage(res, body)}${formatTraceId(props.traceId)}`, props;
   const error = body.error;
   if (typeof error == "string" && typeof body.message == "string")
-    return props.message = `${error} - ${body.message}`, props;
+    return props.message = `${error} - ${body.message}${formatTraceId(props.traceId)}`, props;
   if (typeof error != "object" || error === null)
-    return typeof error == "string" ? props.message = error : typeof body.message == "string" ? props.message = body.message : props.message = httpErrorMessage(res, body), props;
+    return typeof error == "string" ? props.message = `${error}${formatTraceId(props.traceId)}` : typeof body.message == "string" ? props.message = `${body.message}${formatTraceId(props.traceId)}` : props.message = `${httpErrorMessage(res, body)}${formatTraceId(props.traceId)}`, props;
   if (isMutationError(error) || isActionError(error)) {
     const allItems = error.items || [], items = allItems.slice(0, MAX_ITEMS_IN_ERROR_MESSAGE).map((item) => item.error?.description).filter(Boolean);
     let itemsStr = items.length ? `:
 - ${items.join(`
 - `)}` : "";
     return allItems.length > MAX_ITEMS_IN_ERROR_MESSAGE && (itemsStr += `
-...and ${allItems.length - MAX_ITEMS_IN_ERROR_MESSAGE} more`), props.message = `${error.description}${itemsStr}`, props.details = body.error, props;
+...and ${allItems.length - MAX_ITEMS_IN_ERROR_MESSAGE} more`), props.message = `${error.description}${formatTraceId(props.traceId)}${itemsStr}`, props.details = body.error, props;
   }
   if (isQueryParseError(error)) {
     const tag = context?.options?.query?.tag;
-    return props.message = formatQueryParseError(error, tag), props.details = body.error, props;
+    return props.message = formatQueryParseError(error, tag, props.traceId), props.details = body.error, props;
   }
-  return "description" in error && typeof error.description == "string" ? (props.message = error.description, props.details = error, props) : (props.message = httpErrorMessage(res, body), props);
+  return "description" in error && typeof error.description == "string" ? (props.message = `${error.description}${formatTraceId(props.traceId)}`, props.details = error, props) : (props.message = `${httpErrorMessage(res, body)}${formatTraceId(props.traceId)}`, props);
 }
 function isMutationError(error) {
   return "type" in error && error.type === "mutationError" && "description" in error && typeof error.description == "string";
@@ -141,23 +144,32 @@ function isActionError(error) {
 function isQueryParseError(error) {
   return isRecord(error) && error.type === "queryParseError" && typeof error.query == "string" && typeof error.start == "number" && typeof error.end == "number";
 }
-function formatQueryParseError(error, tag) {
-  const { query, start, end, description } = error;
+function formatQueryParseError(error, tag, traceId) {
+  const { query, start, end, description } = error, withTraceId = traceId ? `
+(traceId: ${traceId})` : "";
   if (!query || typeof start > "u")
-    return `GROQ query parse error: ${description}`;
+    return `GROQ query parse error: ${description}${withTraceId}`;
   const withTag = tag ? `
 
 Tag: ${tag}` : "";
   return `GROQ query parse error:
-${codeFrame(query, { start, end }, description)}${withTag}`;
+${codeFrame(query, { start, end }, description)}${withTag}${withTraceId}`;
 }
 function httpErrorMessage(res, body) {
   const details = typeof body == "string" ? ` (${sliceWithEllipsis(body, 100)})` : "", statusMessage = res.statusMessage ? ` ${res.statusMessage}` : "";
   return `${res.method}-request to ${res.url} resulted in HTTP ${res.statusCode}${statusMessage}${details}`;
 }
+function extractTraceId(res) {
+  const traceparent = res?.headers?.traceparent;
+  if (traceparent)
+    return traceparent.split("-")[1];
+}
 function stringifyBody(body, res) {
   return (res.headers["content-type"] || "").toLowerCase().indexOf("application/json") !== -1 ? JSON.stringify(body, null, 2) : body;
 }
+function formatTraceId(traceId) {
+  return traceId ? ` (traceId: ${traceId})` : "";
+}
 function sliceWithEllipsis(str, max) {
   return str.length > max ? `${str.slice(0, max)}\u2026` : str;
 }
@@ -2774,7 +2786,7 @@ function defineDeprecatedCreateClient(createClient2) {
     return printNoDefaultExport(), createClient2(config);
   };
 }
-var name = "@sanity/client", version = "7.21.0";
+var name = "@sanity/client", version = "7.22.0";
 const middleware = [
   debug({ verbose: !0, namespace: "sanity:client" }),
   headers({ "User-Agent": `${name} ${version}` }),