@dynatrace-sdk/client-query 1.4.0 → 1.4.1

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 @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

package/README.md

@@ -1,6 +1,6 @@
 # @dynatrace-sdk/client-query
 
-[![npm](https://img.shields.io/badge/npm-v1.4.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.4.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}"`)
         );
       }
     }
@@ -3039,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;
@@ -3080,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}"`)
         );
       }
     }
@@ -3121,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) {
@@ -3140,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;
@@ -3158,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;
@@ -3206,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}"`)
         );
       }
     }
@@ -3237,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;
@@ -3281,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}"`)
         );
       }
     }

package/docs/DOCS.md

@@ -17,7 +17,7 @@ import NpmLogo from '@site/static/img/npm-logo.png';
     </a>
   </div>
   <div class="col" style={{textAlign: 'right'}}>
-    <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.4.0">v1.4.0</a>
+    <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.4.1">v1.4.1</a>
   </div>
 </div>
 

package/dynatrace-metadata.json

@@ -1,10 +1,10 @@
 {
   "dynagen": {
-    "version": "0.10.9",
+    "version": "0.10.10",
     "generatedAt": "",
     "template": {
       "name": "@dynatrace-sdk/template-typescript-client",
-      "version": "0.17.4"
+      "version": "0.17.6"
     },
     "featureFlags": {
       "typeguards": true

package/esm/index.js

@@ -112,6 +112,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;
@@ -127,6 +148,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 = {};
@@ -1455,7 +1479,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;
@@ -1473,7 +1502,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;
@@ -1507,7 +1541,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}"`)
         );
       }
     }
@@ -1547,7 +1581,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) {
@@ -1566,7 +1603,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;
@@ -1600,7 +1642,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}"`)
         );
       }
     }
@@ -1640,7 +1682,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) {
@@ -1659,7 +1704,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;
@@ -1693,7 +1743,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}"`)
         );
       }
     }
@@ -2974,14 +3024,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;
@@ -3015,7 +3070,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}"`)
         );
       }
     }
@@ -3056,7 +3111,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) {
@@ -3075,7 +3133,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;
@@ -3093,7 +3156,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;
@@ -3141,7 +3209,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}"`)
         );
       }
     }
@@ -3172,14 +3240,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;
@@ -3216,7 +3289,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}"`)
         );
       }
     }
@@ -3347,6 +3420,7 @@ export {
   isApiClientError,
   isClientRequestError,
   isErrorEnvelopeError,
+  isInvalidResponseError,
   queryAssistanceClient,
   queryExecutionClient
 };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@dynatrace-sdk/client-query",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "dependencies": {
-    "@dynatrace-sdk/http-client": "^1.0.3"
+    "@dynatrace-sdk/http-client": "^1.0.5"
   },
   "license": "Apache-2.0",
   "main": "./cjs/index.js",

package/types/packages/client/query/src/lib/error-envelopes/get-error-message.d.ts

@@ -0,0 +1 @@
+export declare function getErrorMessage(errorBody: unknown, defaultMessage: string): string;

package/types/packages/client/query/src/lib/error-envelopes/index.d.ts

@@ -1,3 +1,4 @@
 export { isClientRequestError } from './client-request-error';
 export { isApiClientError } from './api-client-error';
+export { isInvalidResponseError } from './invalid-response-error';
 export { isErrorEnvelopeError } from './error-envelope-error';