@dynatrace-sdk/client-query 1.4.2 → 1.5.0

package/CHANGELOG.md

@@ -1,13 +1,26 @@
-# Storage – Query Service
+# DQL Query
 
 @dynatrace-sdk/client-query
 
+## 1.5.0
+
+### Minor Changes
+
+- Change title from **Storage – Query Service** to **DQL Query**
+- Support 400 error code for poll and cancel operations.
+
+## 1.4.3
+
+### Patch Changes
+
+- Fix transformation of null values for nullable properties
+
 ## 1.4.2
 
 ### Patch Changes
 
 - Update documentation
-- Fix transformation of null and Date values.
+- Fix transformation of null and Date values
 - Update package description
 - Updated dependencies 
 

package/README.md

@@ -1,6 +1,6 @@
 # @dynatrace-sdk/client-query
 
-[![npm](https://img.shields.io/badge/npm-v1.4.2-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.4.2)
+[![npm](https://img.shields.io/badge/npm-v1.5.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.5.0)
 [![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

@@ -636,7 +636,7 @@ function fromJson8($model) {
   return {
     ...fromJson6($model, false),
     type,
-    children: children !== void 0 ? children?.map((innerValue) => fromJson6(innerValue)) : void 0
+    children: children !== void 0 && children !== null ? children?.map((innerValue) => fromJson6(innerValue)) : void 0
   };
 }
 function toJson8($model) {
@@ -721,7 +721,7 @@ function fromJson10($model) {
   const { type, isMandatoryOnUserOrder, canonicalString } = $model;
   return {
     ...fromJson6($model, false),
-    type: type !== void 0 ? fromJson2(type) : void 0,
+    type: type !== void 0 && type !== null ? fromJson2(type) : void 0,
     isMandatoryOnUserOrder,
     canonicalString
   };
@@ -929,7 +929,7 @@ function fromJson6($model, includeChildProps = true) {
   const { nodeType, tokenPosition, isOptional } = $model;
   return {
     nodeType: fromJson9(nodeType),
-    tokenPosition: tokenPosition !== void 0 ? fromJson12(tokenPosition) : void 0,
+    tokenPosition: tokenPosition !== void 0 && tokenPosition !== null ? fromJson12(tokenPosition) : void 0,
     isOptional
   };
 }
@@ -1069,7 +1069,7 @@ function fromJson13($model) {
   } = $model;
   return {
     exceptionType,
-    syntaxErrorPosition: syntaxErrorPosition !== void 0 ? fromJson12(syntaxErrorPosition) : void 0,
+    syntaxErrorPosition: syntaxErrorPosition !== void 0 && syntaxErrorPosition !== null ? fromJson12(syntaxErrorPosition) : void 0,
     errorType,
     errorMessage,
     arguments: _arguments?.slice(0),
@@ -1456,9 +1456,9 @@ function fromJson18($model) {
   return {
     severity,
     messageFormat,
-    syntaxPosition: syntaxPosition !== void 0 ? fromJson12(syntaxPosition) : void 0,
-    messageFormatSpecifierTypes: messageFormatSpecifierTypes !== void 0 ? messageFormatSpecifierTypes?.slice(0) : void 0,
-    arguments: _arguments !== void 0 ? _arguments?.slice(0) : void 0,
+    syntaxPosition: syntaxPosition !== void 0 && syntaxPosition !== null ? fromJson12(syntaxPosition) : void 0,
+    messageFormatSpecifierTypes: messageFormatSpecifierTypes !== void 0 && messageFormatSpecifierTypes !== null ? messageFormatSpecifierTypes?.slice(0) : void 0,
+    arguments: _arguments !== void 0 && _arguments !== null ? _arguments?.slice(0) : void 0,
     notificationType,
     message
   };
@@ -1529,7 +1529,7 @@ function fromJson19($model) {
   const { valid, notifications } = $model;
   return {
     valid,
-    notifications: notifications !== void 0 ? notifications?.map((innerValue) => fromJson18(innerValue)) : void 0
+    notifications: notifications !== void 0 && notifications !== null ? notifications?.map((innerValue) => fromJson18(innerValue)) : void 0
   };
 }
 function toJson19($model) {
@@ -2099,8 +2099,8 @@ function isJson21(value) {
 function fromJson21($model) {
   const { start, end } = $model;
   return {
-    start: start !== void 0 ? new Date(start) : void 0,
-    end: end !== void 0 ? new Date(end) : void 0
+    start: start !== void 0 && start !== null ? new Date(start) : void 0,
+    end: end !== void 0 && end !== null ? new Date(end) : void 0
   };
 }
 function toJson21($model) {
@@ -2226,10 +2226,10 @@ function fromJson22($model) {
     scannedRecords,
     dqlVersion,
     scannedBytes,
-    analysisTimeframe: analysisTimeframe !== void 0 ? fromJson21(analysisTimeframe) : void 0,
+    analysisTimeframe: analysisTimeframe !== void 0 && analysisTimeframe !== null ? fromJson21(analysisTimeframe) : void 0,
     locale,
     executionTimeMilliseconds,
-    notifications: notifications !== void 0 ? notifications?.map((innerValue) => fromJson18(innerValue)) : void 0,
+    notifications: notifications !== void 0 && notifications !== null ? notifications?.map((innerValue) => fromJson18(innerValue)) : void 0,
     queryId,
     sampled
   };
@@ -2378,8 +2378,8 @@ function isJson24(value) {
 function fromJson24($model) {
   const { grail, metrics } = $model;
   return {
-    grail: grail !== void 0 ? fromJson22(grail) : void 0,
-    metrics: metrics !== void 0 ? metrics?.map((innerValue) => fromJson23(innerValue)) : void 0
+    grail: grail !== void 0 && grail !== null ? fromJson22(grail) : void 0,
+    metrics: metrics !== void 0 && metrics !== null ? metrics?.map((innerValue) => fromJson23(innerValue)) : void 0
   };
 }
 function toJson24($model) {
@@ -2483,7 +2483,7 @@ function fromJson27($model) {
   const { type, types } = $model;
   return {
     type: fromJson25(type),
-    types: types !== void 0 ? types?.map((innerValue) => fromJson26(innerValue)) : void 0
+    types: types !== void 0 && types !== null ? types?.map((innerValue) => fromJson26(innerValue)) : void 0
   };
 }
 function toJson27($model) {
@@ -2541,7 +2541,7 @@ function fromJson28($model) {
     ...Object.fromEntries(
       Object.entries(additionalProps).map(([propName, value]) => [
         propName,
-        value !== void 0 ? fromJson27(value) : void 0
+        value !== void 0 && value !== null ? fromJson27(value) : void 0
       ])
     )
   };
@@ -2603,7 +2603,7 @@ function fromJson26($model) {
   const { mappings, indexRange } = $model;
   return {
     mappings: fromJson28(mappings),
-    indexRange: indexRange !== void 0 ? indexRange?.slice(0) : void 0
+    indexRange: indexRange !== void 0 && indexRange !== null ? indexRange?.slice(0) : void 0
   };
 }
 function toJson26($model) {
@@ -3010,7 +3010,7 @@ function isJson34(value) {
 function fromJson34($model) {
   const { result, ttlSeconds, progress, state } = $model;
   return {
-    result: result !== void 0 ? fromJson32(result) : void 0,
+    result: result !== void 0 && result !== null ? fromJson32(result) : void 0,
     ttlSeconds,
     progress,
     state: fromJson33(state)
@@ -3077,7 +3077,7 @@ function isJson35(value) {
 function fromJson35($model) {
   const { result, ttlSeconds, progress, requestToken, state } = $model;
   return {
-    result: result !== void 0 ? fromJson32(result) : void 0,
+    result: result !== void 0 && result !== null ? fromJson32(result) : void 0,
     ttlSeconds,
     progress,
     requestToken,
@@ -3139,10 +3139,36 @@ var QueryExecutionClient = class {
         if (200 <= status && status < 300) {
           return true;
         }
-        return [410, 500].includes(status);
+        return [400, 410, 500].includes(status);
       }
     });
     switch (response.status) {
+      case 400: {
+        const responseValue = await response.body("json");
+        try {
+          const errorBody = fromJson15(responseValue);
+          throw new ErrorEnvelopeError(
+            "400",
+            response,
+            errorBody,
+            getErrorMessage(
+              errorBody,
+              "The supplied request is wrong. Either the query itself or other parameters are wrong."
+            )
+          );
+        } catch (err) {
+          if (err instanceof ErrorEnvelopeError) {
+            throw err;
+          }
+          throw new InvalidResponseError(
+            `QueryExecutionClient.query:poll:400`,
+            err,
+            responseValue,
+            "ErrorEnvelope",
+            void 0
+          );
+        }
+      }
       case 410: {
         const responseValue = await response.body("text");
         throw new ClientRequestError(
@@ -3355,10 +3381,36 @@ var QueryExecutionClient = class {
         if (200 <= status && status < 300) {
           return true;
         }
-        return [410, 500].includes(status);
+        return [400, 410, 500].includes(status);
       }
     });
     switch (response.status) {
+      case 400: {
+        const responseValue = await response.body("json");
+        try {
+          const errorBody = fromJson15(responseValue);
+          throw new ErrorEnvelopeError(
+            "400",
+            response,
+            errorBody,
+            getErrorMessage(
+              errorBody,
+              "The supplied request is wrong. Either the query itself or other parameters are wrong."
+            )
+          );
+        } catch (err) {
+          if (err instanceof ErrorEnvelopeError) {
+            throw err;
+          }
+          throw new InvalidResponseError(
+            `QueryExecutionClient.query:cancel:400`,
+            err,
+            responseValue,
+            "ErrorEnvelope",
+            void 0
+          );
+        }
+      }
       case 410: {
         const responseValue = await response.body("text");
         throw new ClientRequestError(

package/docs/DOCS.md

@@ -1,9 +1,9 @@
 ---
-title: Storage – Query Service
+title: "DQL Query"
 description: Exposes an API to fetch records stored in Grail.
 ---
 
-# Storage – Query Service
+# DQL Query
 
 Exposes an API to fetch records stored in Grail
 
@@ -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.2">v1.4.2</a>
+    <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.5.0">v1.5.0</a>
   </div>
 </div>
 
@@ -783,8 +783,8 @@ DQL data type representing a geolocation point.
 
 | Name                           | Type                                                                          | Description                                                                                    |
 | ------------------------------ | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| latitude<sup>\*required</sup>  | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The coordinate that specifies the north–south position of a point on the surface of the earth. |
-| longitude<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The coordinate that specifies the east–west position of a point on the surface of the earth.   |
+| latitude<sup>\*required</sup>  | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The coordinate that specifies the north-south position of a point on the surface of the earth. |
+| longitude<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The coordinate that specifies the east-west position of a point on the surface of the earth.   |
 
 ### GrailMetadata
 

package/dynatrace-metadata.json

@@ -1,18 +1,18 @@
 {
   "dynagen": {
-    "version": "0.12.1",
+    "version": "0.12.3",
     "generatedAt": "",
     "template": {
       "name": "@dynatrace-sdk/template-typescript-client",
-      "version": "0.17.8"
+      "version": "0.17.10"
     },
     "featureFlags": {
       "typeguards": true
     }
   },
   "spec": {
-    "title": "Storage – Query Service",
-    "version": "1.3.0",
+    "title": "DQL Query",
+    "version": "1.4.0",
     "baseUrl": "/platform/storage/query/v1"
   }
 }

package/esm/index.js

@@ -570,7 +570,7 @@ function fromJson8($model) {
   return {
     ...fromJson6($model, false),
     type,
-    children: children !== void 0 ? children?.map((innerValue) => fromJson6(innerValue)) : void 0
+    children: children !== void 0 && children !== null ? children?.map((innerValue) => fromJson6(innerValue)) : void 0
   };
 }
 function toJson8($model) {
@@ -655,7 +655,7 @@ function fromJson10($model) {
   const { type, isMandatoryOnUserOrder, canonicalString } = $model;
   return {
     ...fromJson6($model, false),
-    type: type !== void 0 ? fromJson2(type) : void 0,
+    type: type !== void 0 && type !== null ? fromJson2(type) : void 0,
     isMandatoryOnUserOrder,
     canonicalString
   };
@@ -863,7 +863,7 @@ function fromJson6($model, includeChildProps = true) {
   const { nodeType, tokenPosition, isOptional } = $model;
   return {
     nodeType: fromJson9(nodeType),
-    tokenPosition: tokenPosition !== void 0 ? fromJson12(tokenPosition) : void 0,
+    tokenPosition: tokenPosition !== void 0 && tokenPosition !== null ? fromJson12(tokenPosition) : void 0,
     isOptional
   };
 }
@@ -1003,7 +1003,7 @@ function fromJson13($model) {
   } = $model;
   return {
     exceptionType,
-    syntaxErrorPosition: syntaxErrorPosition !== void 0 ? fromJson12(syntaxErrorPosition) : void 0,
+    syntaxErrorPosition: syntaxErrorPosition !== void 0 && syntaxErrorPosition !== null ? fromJson12(syntaxErrorPosition) : void 0,
     errorType,
     errorMessage,
     arguments: _arguments?.slice(0),
@@ -1390,9 +1390,9 @@ function fromJson18($model) {
   return {
     severity,
     messageFormat,
-    syntaxPosition: syntaxPosition !== void 0 ? fromJson12(syntaxPosition) : void 0,
-    messageFormatSpecifierTypes: messageFormatSpecifierTypes !== void 0 ? messageFormatSpecifierTypes?.slice(0) : void 0,
-    arguments: _arguments !== void 0 ? _arguments?.slice(0) : void 0,
+    syntaxPosition: syntaxPosition !== void 0 && syntaxPosition !== null ? fromJson12(syntaxPosition) : void 0,
+    messageFormatSpecifierTypes: messageFormatSpecifierTypes !== void 0 && messageFormatSpecifierTypes !== null ? messageFormatSpecifierTypes?.slice(0) : void 0,
+    arguments: _arguments !== void 0 && _arguments !== null ? _arguments?.slice(0) : void 0,
     notificationType,
     message
   };
@@ -1463,7 +1463,7 @@ function fromJson19($model) {
   const { valid, notifications } = $model;
   return {
     valid,
-    notifications: notifications !== void 0 ? notifications?.map((innerValue) => fromJson18(innerValue)) : void 0
+    notifications: notifications !== void 0 && notifications !== null ? notifications?.map((innerValue) => fromJson18(innerValue)) : void 0
   };
 }
 function toJson19($model) {
@@ -2033,8 +2033,8 @@ function isJson21(value) {
 function fromJson21($model) {
   const { start, end } = $model;
   return {
-    start: start !== void 0 ? new Date(start) : void 0,
-    end: end !== void 0 ? new Date(end) : void 0
+    start: start !== void 0 && start !== null ? new Date(start) : void 0,
+    end: end !== void 0 && end !== null ? new Date(end) : void 0
   };
 }
 function toJson21($model) {
@@ -2160,10 +2160,10 @@ function fromJson22($model) {
     scannedRecords,
     dqlVersion,
     scannedBytes,
-    analysisTimeframe: analysisTimeframe !== void 0 ? fromJson21(analysisTimeframe) : void 0,
+    analysisTimeframe: analysisTimeframe !== void 0 && analysisTimeframe !== null ? fromJson21(analysisTimeframe) : void 0,
     locale,
     executionTimeMilliseconds,
-    notifications: notifications !== void 0 ? notifications?.map((innerValue) => fromJson18(innerValue)) : void 0,
+    notifications: notifications !== void 0 && notifications !== null ? notifications?.map((innerValue) => fromJson18(innerValue)) : void 0,
     queryId,
     sampled
   };
@@ -2312,8 +2312,8 @@ function isJson24(value) {
 function fromJson24($model) {
   const { grail, metrics } = $model;
   return {
-    grail: grail !== void 0 ? fromJson22(grail) : void 0,
-    metrics: metrics !== void 0 ? metrics?.map((innerValue) => fromJson23(innerValue)) : void 0
+    grail: grail !== void 0 && grail !== null ? fromJson22(grail) : void 0,
+    metrics: metrics !== void 0 && metrics !== null ? metrics?.map((innerValue) => fromJson23(innerValue)) : void 0
   };
 }
 function toJson24($model) {
@@ -2417,7 +2417,7 @@ function fromJson27($model) {
   const { type, types } = $model;
   return {
     type: fromJson25(type),
-    types: types !== void 0 ? types?.map((innerValue) => fromJson26(innerValue)) : void 0
+    types: types !== void 0 && types !== null ? types?.map((innerValue) => fromJson26(innerValue)) : void 0
   };
 }
 function toJson27($model) {
@@ -2475,7 +2475,7 @@ function fromJson28($model) {
     ...Object.fromEntries(
       Object.entries(additionalProps).map(([propName, value]) => [
         propName,
-        value !== void 0 ? fromJson27(value) : void 0
+        value !== void 0 && value !== null ? fromJson27(value) : void 0
       ])
     )
   };
@@ -2537,7 +2537,7 @@ function fromJson26($model) {
   const { mappings, indexRange } = $model;
   return {
     mappings: fromJson28(mappings),
-    indexRange: indexRange !== void 0 ? indexRange?.slice(0) : void 0
+    indexRange: indexRange !== void 0 && indexRange !== null ? indexRange?.slice(0) : void 0
   };
 }
 function toJson26($model) {
@@ -2944,7 +2944,7 @@ function isJson34(value) {
 function fromJson34($model) {
   const { result, ttlSeconds, progress, state } = $model;
   return {
-    result: result !== void 0 ? fromJson32(result) : void 0,
+    result: result !== void 0 && result !== null ? fromJson32(result) : void 0,
     ttlSeconds,
     progress,
     state: fromJson33(state)
@@ -3011,7 +3011,7 @@ function isJson35(value) {
 function fromJson35($model) {
   const { result, ttlSeconds, progress, requestToken, state } = $model;
   return {
-    result: result !== void 0 ? fromJson32(result) : void 0,
+    result: result !== void 0 && result !== null ? fromJson32(result) : void 0,
     ttlSeconds,
     progress,
     requestToken,
@@ -3073,10 +3073,36 @@ var QueryExecutionClient = class {
         if (200 <= status && status < 300) {
           return true;
         }
-        return [410, 500].includes(status);
+        return [400, 410, 500].includes(status);
       }
     });
     switch (response.status) {
+      case 400: {
+        const responseValue = await response.body("json");
+        try {
+          const errorBody = fromJson15(responseValue);
+          throw new ErrorEnvelopeError(
+            "400",
+            response,
+            errorBody,
+            getErrorMessage(
+              errorBody,
+              "The supplied request is wrong. Either the query itself or other parameters are wrong."
+            )
+          );
+        } catch (err) {
+          if (err instanceof ErrorEnvelopeError) {
+            throw err;
+          }
+          throw new InvalidResponseError(
+            `QueryExecutionClient.query:poll:400`,
+            err,
+            responseValue,
+            "ErrorEnvelope",
+            void 0
+          );
+        }
+      }
       case 410: {
         const responseValue = await response.body("text");
         throw new ClientRequestError(
@@ -3289,10 +3315,36 @@ var QueryExecutionClient = class {
         if (200 <= status && status < 300) {
           return true;
         }
-        return [410, 500].includes(status);
+        return [400, 410, 500].includes(status);
       }
     });
     switch (response.status) {
+      case 400: {
+        const responseValue = await response.body("json");
+        try {
+          const errorBody = fromJson15(responseValue);
+          throw new ErrorEnvelopeError(
+            "400",
+            response,
+            errorBody,
+            getErrorMessage(
+              errorBody,
+              "The supplied request is wrong. Either the query itself or other parameters are wrong."
+            )
+          );
+        } catch (err) {
+          if (err instanceof ErrorEnvelopeError) {
+            throw err;
+          }
+          throw new InvalidResponseError(
+            `QueryExecutionClient.query:cancel:400`,
+            err,
+            responseValue,
+            "ErrorEnvelope",
+            void 0
+          );
+        }
+      }
       case 410: {
         const responseValue = await response.body("text");
         throw new ClientRequestError(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynatrace-sdk/client-query",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "Exposes an API to fetch records stored in Grail.",
   "license": "Apache-2.0",
   "dependencies": {

package/types/packages/client/query/src/lib/models/geo-point.d.ts

@@ -3,11 +3,11 @@
  */
 export interface GeoPoint {
     /**
-     * The coordinate that specifies the north–south position of a point on the surface of the earth.
+     * The coordinate that specifies the north-south position of a point on the surface of the earth.
      */
     latitude: number;
     /**
-     * The coordinate that specifies the  east–west position of a point on the surface of the earth.
+     * The coordinate that specifies the  east-west position of a point on the surface of the earth.
      */
     longitude: number;
 }

package/types/packages/platform/error-handlers/src/lib/types/serialized-error.d.ts

@@ -5,4 +5,6 @@ import { HttpSerializedError } from './http-serialized-error';
  *
  * @property {ErrorType} type error type
  */
-export declare type SerializedError = HttpSerializedError | CommonSerializedError;
+export declare type SerializedError = (HttpSerializedError | CommonSerializedError) & {
+    traceId?: string;
+};