@dynatrace-sdk/client-query 1.3.0 → 1.4.1

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
@@ -12,7 +12,7 @@
   },
   "spec": {
     "title": "Storage – Query Service",
-    "version": "1.2.0",
+    "version": "1.3.0",
     "baseUrl": "/platform/storage/query/v1"
   }
 }

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}"`)
         );
       }
     }
@@ -1729,6 +1779,7 @@ function isExecuteRequest(value) {
     "timezone",
     "locale",
     "maxResultRecords",
+    "maxResultBytes",
     "fetchTimeoutSeconds",
     "requestTimeoutMilliseconds",
     "enablePreview",
@@ -1743,6 +1794,7 @@ function isExecuteRequest(value) {
     "timezone",
     "locale",
     "maxResultRecords",
+    "maxResultBytes",
     "fetchTimeoutSeconds",
     "requestTimeoutMilliseconds",
     "enablePreview",
@@ -1771,6 +1823,7 @@ function isJson20(value) {
     "timezone",
     "locale",
     "maxResultRecords",
+    "maxResultBytes",
     "fetchTimeoutSeconds",
     "requestTimeoutMilliseconds",
     "enablePreview",
@@ -1785,6 +1838,7 @@ function isJson20(value) {
     "timezone",
     "locale",
     "maxResultRecords",
+    "maxResultBytes",
     "fetchTimeoutSeconds",
     "requestTimeoutMilliseconds",
     "enablePreview",
@@ -1804,6 +1858,7 @@ function fromJson20($model) {
     timezone,
     locale,
     maxResultRecords,
+    maxResultBytes,
     fetchTimeoutSeconds,
     requestTimeoutMilliseconds,
     enablePreview,
@@ -1817,6 +1872,7 @@ function fromJson20($model) {
     timezone,
     locale,
     maxResultRecords,
+    maxResultBytes,
     fetchTimeoutSeconds,
     requestTimeoutMilliseconds,
     enablePreview,
@@ -1832,6 +1888,7 @@ function toJson20($model) {
     timezone,
     locale,
     maxResultRecords,
+    maxResultBytes,
     fetchTimeoutSeconds,
     requestTimeoutMilliseconds,
     enablePreview,
@@ -1845,6 +1902,7 @@ function toJson20($model) {
     timezone,
     locale,
     maxResultRecords,
+    maxResultBytes,
     fetchTimeoutSeconds,
     requestTimeoutMilliseconds,
     enablePreview,
@@ -2966,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;
@@ -3007,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}"`)
         );
       }
     }
@@ -3048,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) {
@@ -3067,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;
@@ -3085,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;
@@ -3133,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}"`)
         );
       }
     }
@@ -3164,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;
@@ -3208,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}"`)
         );
       }
     }
@@ -3339,6 +3420,7 @@ export {
   isApiClientError,
   isClientRequestError,
   isErrorEnvelopeError,
+  isInvalidResponseError,
   queryAssistanceClient,
   queryExecutionClient
 };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@dynatrace-sdk/client-query",
-  "version": "1.3.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';

package/types/packages/client/query/src/lib/models/execute-request.d.ts

@@ -23,6 +23,10 @@ export interface ExecuteRequest {
      * The maximum number of result records that this query will return.
      */
     maxResultRecords?: number;
+    /**
+     * The maximum number of result bytes that this query will return.
+     */
+    maxResultBytes?: number;
     /**
      * The query will stop after reaching the fetch-timeout.
      */

package/types/packages/client/query/src/lib/models/execute-request.transformation.d.ts

@@ -6,6 +6,7 @@ export interface AsJson {
     timezone?: string;
     locale?: string;
     maxResultRecords?: number;
+    maxResultBytes?: number;
     fetchTimeoutSeconds?: number;
     requestTimeoutMilliseconds?: number;
     enablePreview?: boolean;