@dynatrace-sdk/client-query 1.3.0 → 1.4.1

package/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 @dynatrace-sdk/client-query
 
+## 1.4.1
+
+### Patch Changes
+
+- Update error messages
+- Updated dependencies 
+
+  - @dynatrace-sdk/http-client@1.0.5
+
+## 1.4.0
+
+### Minor Changes
+
+- Add `max-result-bytes` query parameter to DPS Query API
+
+## 1.3.1
+
+### Patch Changes
+
+- Update documentation
+
 ## 1.3.0
 
 ### Minor Changes

package/README.md

@@ -1,6 +1,6 @@
 # @dynatrace-sdk/client-query
 
-[![npm](https://img.shields.io/badge/npm-v1.3.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.3.0)
+[![npm](https://img.shields.io/badge/npm-v1.4.1-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.4.1)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 Exposes an API to fetch records stored in Grail

package/cjs/index.js

@@ -79,6 +79,7 @@ __export(src_exports, {
   isApiClientError: () => isApiClientError,
   isClientRequestError: () => isClientRequestError,
   isErrorEnvelopeError: () => isErrorEnvelopeError,
+  isInvalidResponseError: () => isInvalidResponseError,
   queryAssistanceClient: () => queryAssistanceClient,
   queryExecutionClient: () => queryExecutionClient
 });
@@ -177,6 +178,27 @@ function getOptionalErrorRef(body) {
   return {};
 }
 
+// packages/client/query/src/lib/error-envelopes/get-error-message.ts
+function getMessagesFromErrorDetails(details) {
+  const messages = [];
+  Object.entries(details).forEach(([name, data]) => {
+    switch (name) {
+      case "missingScopes":
+        messages.push(`Missing scopes: ${data}`);
+        break;
+      default:
+        messages.push(`${name}: ${data}`);
+    }
+  }, []);
+  return messages;
+}
+function getErrorMessage(errorBody, defaultMessage) {
+  const error = errorBody;
+  const msg = error?.error?.message || defaultMessage;
+  const details = error?.error?.details || {};
+  return [msg, ...getMessagesFromErrorDetails(details)].join(". ");
+}
+
 // packages/client/query/src/lib/error-envelopes/invalid-response-error.ts
 var InvalidResponseError = class extends ApiClientError {
   responseBody;
@@ -192,6 +214,9 @@ var InvalidResponseError = class extends ApiClientError {
     this.expectedType = expectedType;
   }
 };
+function isInvalidResponseError(e) {
+  return e instanceof InvalidResponseError;
+}
 
 // packages/client/query/src/lib/models/autocomplete-request.transformation.ts
 var autocomplete_request_transformation_exports = {};
@@ -1520,7 +1545,12 @@ var QueryAssistanceClient = class {
         const responseValue = await response.body("json");
         try {
           const errorBody = fromJson15(responseValue);
-          throw new ErrorEnvelopeError("400", response, errorBody, "The supplied request is wrong.");
+          throw new ErrorEnvelopeError(
+            "400",
+            response,
+            errorBody,
+            getErrorMessage(errorBody, "The supplied request is wrong.")
+          );
         } catch (err) {
           if (err instanceof ErrorEnvelopeError) {
             throw err;
@@ -1538,7 +1568,12 @@ var QueryAssistanceClient = class {
         const responseValue = await response.body("json");
         try {
           const errorBody = fromJson15(responseValue);
-          throw new ErrorEnvelopeError("500", response, errorBody, "An internal server error has occurred.");
+          throw new ErrorEnvelopeError(
+            "500",
+            response,
+            errorBody,
+            getErrorMessage(errorBody, "An internal server error has occurred.")
+          );
         } catch (err) {
           if (err instanceof ErrorEnvelopeError) {
             throw err;
@@ -1572,7 +1607,7 @@ var QueryAssistanceClient = class {
           `${response.status}`,
           response,
           responseValue,
-          `Unexpected api response: code=${response.status} body="${responseValue}"`
+          getErrorMessage(responseValue, `Unexpected api response: code=${response.status} body="${responseValue}"`)
         );
       }
     }
@@ -1612,7 +1647,10 @@ var QueryAssistanceClient = class {
             "400",
             response,
             errorBody,
-            "The supplied request is wrong. Either the query itself or other parameters are wrong."
+            getErrorMessage(
+              errorBody,
+              "The supplied request is wrong. Either the query itself or other parameters are wrong."
+            )
           );
         } catch (err) {
           if (err instanceof ErrorEnvelopeError) {
@@ -1631,7 +1669,12 @@ var QueryAssistanceClient = class {
         const responseValue = await response.body("json");
         try {
           const errorBody = fromJson15(responseValue);
-          throw new ErrorEnvelopeError("500", response, errorBody, "An internal server error has occurred.");
+          throw new ErrorEnvelopeError(
+            "500",
+            response,
+            errorBody,
+            getErrorMessage(errorBody, "An internal server error has occurred.")
+          );
         } catch (err) {
           if (err instanceof ErrorEnvelopeError) {
             throw err;
@@ -1665,7 +1708,7 @@ var QueryAssistanceClient = class {
           `${response.status}`,
           response,
           responseValue,
-          `Unexpected api response: code=${response.status} body="${responseValue}"`
+          getErrorMessage(responseValue, `Unexpected api response: code=${response.status} body="${responseValue}"`)
         );
       }
     }
@@ -1705,7 +1748,10 @@ var QueryAssistanceClient = class {
             "400",
             response,
             errorBody,
-            "The supplied request is wrong. Either the query itself or other parameters are wrong."
+            getErrorMessage(
+              errorBody,
+              "The supplied request is wrong. Either the query itself or other parameters are wrong."
+            )
           );
         } catch (err) {
           if (err instanceof ErrorEnvelopeError) {
@@ -1724,7 +1770,12 @@ var QueryAssistanceClient = class {
         const responseValue = await response.body("json");
         try {
           const errorBody = fromJson15(responseValue);
-          throw new ErrorEnvelopeError("500", response, errorBody, "An internal server error has occurred.");
+          throw new ErrorEnvelopeError(
+            "500",
+            response,
+            errorBody,
+            getErrorMessage(errorBody, "An internal server error has occurred.")
+          );
         } catch (err) {
           if (err instanceof ErrorEnvelopeError) {
             throw err;
@@ -1758,7 +1809,7 @@ var QueryAssistanceClient = class {
           `${response.status}`,
           response,
           responseValue,
-          `Unexpected api response: code=${response.status} body="${responseValue}"`
+          getErrorMessage(responseValue, `Unexpected api response: code=${response.status} body="${responseValue}"`)
         );
       }
     }
@@ -1794,6 +1845,7 @@ function isExecuteRequest(value) {
     "timezone",
     "locale",
     "maxResultRecords",
+    "maxResultBytes",
     "fetchTimeoutSeconds",
     "requestTimeoutMilliseconds",
     "enablePreview",
@@ -1808,6 +1860,7 @@ function isExecuteRequest(value) {
     "timezone",
     "locale",
     "maxResultRecords",
+    "maxResultBytes",
     "fetchTimeoutSeconds",
     "requestTimeoutMilliseconds",
     "enablePreview",
@@ -1836,6 +1889,7 @@ function isJson20(value) {
     "timezone",
     "locale",
     "maxResultRecords",
+    "maxResultBytes",
     "fetchTimeoutSeconds",
     "requestTimeoutMilliseconds",
     "enablePreview",
@@ -1850,6 +1904,7 @@ function isJson20(value) {
     "timezone",
     "locale",
     "maxResultRecords",
+    "maxResultBytes",
     "fetchTimeoutSeconds",
     "requestTimeoutMilliseconds",
     "enablePreview",
@@ -1869,6 +1924,7 @@ function fromJson20($model) {
     timezone,
     locale,
     maxResultRecords,
+    maxResultBytes,
     fetchTimeoutSeconds,
     requestTimeoutMilliseconds,
     enablePreview,
@@ -1882,6 +1938,7 @@ function fromJson20($model) {
     timezone,
     locale,
     maxResultRecords,
+    maxResultBytes,
     fetchTimeoutSeconds,
     requestTimeoutMilliseconds,
     enablePreview,
@@ -1897,6 +1954,7 @@ function toJson20($model) {
     timezone,
     locale,
     maxResultRecords,
+    maxResultBytes,
     fetchTimeoutSeconds,
     requestTimeoutMilliseconds,
     enablePreview,
@@ -1910,6 +1968,7 @@ function toJson20($model) {
     timezone,
     locale,
     maxResultRecords,
+    maxResultBytes,
     fetchTimeoutSeconds,
     requestTimeoutMilliseconds,
     enablePreview,
@@ -3031,14 +3090,19 @@ var QueryExecutionClient = class {
           `410`,
           response,
           responseValue,
-          `The query for the given request-token is not available anymore.`
+          getErrorMessage(responseValue, `The query for the given request-token is not available anymore.`)
         );
       }
       case 500: {
         const responseValue = await response.body("json");
         try {
           const errorBody = fromJson15(responseValue);
-          throw new ErrorEnvelopeError("500", response, errorBody, "An internal server error has occurred.");
+          throw new ErrorEnvelopeError(
+            "500",
+            response,
+            errorBody,
+            getErrorMessage(errorBody, "An internal server error has occurred.")
+          );
         } catch (err) {
           if (err instanceof ErrorEnvelopeError) {
             throw err;
@@ -3072,7 +3136,7 @@ var QueryExecutionClient = class {
           `${response.status}`,
           response,
           responseValue,
-          `Unexpected api response: code=${response.status} body="${responseValue}"`
+          getErrorMessage(responseValue, `Unexpected api response: code=${response.status} body="${responseValue}"`)
         );
       }
     }
@@ -3113,7 +3177,10 @@ var QueryExecutionClient = class {
             "400",
             response,
             errorBody,
-            "The supplied request is wrong. Either the query itself or other parameters are wrong."
+            getErrorMessage(
+              errorBody,
+              "The supplied request is wrong. Either the query itself or other parameters are wrong."
+            )
           );
         } catch (err) {
           if (err instanceof ErrorEnvelopeError) {
@@ -3132,7 +3199,12 @@ var QueryExecutionClient = class {
         const responseValue = await response.body("json");
         try {
           const errorBody = fromJson15(responseValue);
-          throw new ErrorEnvelopeError("500", response, errorBody, "An internal server error has occurred.");
+          throw new ErrorEnvelopeError(
+            "500",
+            response,
+            errorBody,
+            getErrorMessage(errorBody, "An internal server error has occurred.")
+          );
         } catch (err) {
           if (err instanceof ErrorEnvelopeError) {
             throw err;
@@ -3150,7 +3222,12 @@ var QueryExecutionClient = class {
         const responseValue = await response.body("json");
         try {
           const errorBody = fromJson15(responseValue);
-          throw new ErrorEnvelopeError("503", response, errorBody, "Service is unavailable.");
+          throw new ErrorEnvelopeError(
+            "503",
+            response,
+            errorBody,
+            getErrorMessage(errorBody, "Service is unavailable.")
+          );
         } catch (err) {
           if (err instanceof ErrorEnvelopeError) {
             throw err;
@@ -3198,7 +3275,7 @@ var QueryExecutionClient = class {
           `${response.status}`,
           response,
           responseValue,
-          `Unexpected api response: code=${response.status} body="${responseValue}"`
+          getErrorMessage(responseValue, `Unexpected api response: code=${response.status} body="${responseValue}"`)
         );
       }
     }
@@ -3229,14 +3306,19 @@ var QueryExecutionClient = class {
           `410`,
           response,
           responseValue,
-          `The query for the given request-token is not available anymore.`
+          getErrorMessage(responseValue, `The query for the given request-token is not available anymore.`)
         );
       }
       case 500: {
         const responseValue = await response.body("json");
         try {
           const errorBody = fromJson15(responseValue);
-          throw new ErrorEnvelopeError("500", response, errorBody, "An internal server error has occurred.");
+          throw new ErrorEnvelopeError(
+            "500",
+            response,
+            errorBody,
+            getErrorMessage(errorBody, "An internal server error has occurred.")
+          );
         } catch (err) {
           if (err instanceof ErrorEnvelopeError) {
             throw err;
@@ -3273,7 +3355,7 @@ var QueryExecutionClient = class {
           `${response.status}`,
           response,
           responseValue,
-          `Unexpected api response: code=${response.status} body="${responseValue}"`
+          getErrorMessage(responseValue, `Unexpected api response: code=${response.status} body="${responseValue}"`)
         );
       }
     }