@dynatrace-sdk/client-query 1.4.3 → 1.5.1

package/CHANGELOG.md

@@ -1,7 +1,20 @@
-# Storage – Query Service
+# DQL Query
 
 @dynatrace-sdk/client-query
 
+## 1.5.1
+
+### Patch Changes
+
+- Update JSDoc examples.
+
+## 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

package/README.md

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

@@ -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.3">v1.4.3</a>
+    <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.5.1">v1.5.1</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.3",
+    "version": "0.12.5",
     "generatedAt": "",
     "template": {
       "name": "@dynatrace-sdk/template-typescript-client",
-      "version": "0.17.10"
+      "version": "0.17.13"
     },
     "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

@@ -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.3",
+  "version": "1.5.1",
   "description": "Exposes an API to fetch records stored in Grail.",
   "license": "Apache-2.0",
   "dependencies": {

package/types/packages/client/query/src/lib/apis/query-assistance-api.d.ts

@@ -13,7 +13,7 @@ export declare class QueryAssistanceClient {
     /**
      * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a QueryAssistanceClient. Custom http client should implement {HttpClient} interface.
      * @example
-     * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
+     * const queryAssistanceClientNodeJs = new QueryAssistanceClient(yourCustomImplementation);
      */
     constructor(httpClientImplementation: HttpClient);
     /**

package/types/packages/client/query/src/lib/apis/query-execution-api.d.ts

@@ -10,7 +10,7 @@ export declare class QueryExecutionClient {
     /**
      * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a QueryExecutionClient. Custom http client should implement {HttpClient} interface.
      * @example
-     * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
+     * const queryExecutionClientNodeJs = new QueryExecutionClient(yourCustomImplementation);
      */
     constructor(httpClientImplementation: HttpClient);
     /**

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/http-client/src/lib/platform/http-client-response-error.d.ts

@@ -4,5 +4,8 @@ import { BaseError } from './base-error';
 export declare class HttpClientResponseError extends BaseError implements types.HttpClientResponseError {
     readonly name = "ResponseError";
     readonly response: HttpClientResponse;
-    constructor(response: Response);
+    readonly requestMethod?: string;
+    constructor(response: Response, data?: {
+        requestMethod?: string;
+    });
 }

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

@@ -8,4 +8,6 @@ export interface CommonSerializedError {
     stack?: string;
     type: ErrorType.COMMON;
     errorRef?: string;
+    cause?: any;
+    details?: any;
 }

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

@@ -8,6 +8,9 @@ export interface HttpSerializedError {
     stack?: string;
     type: ErrorType.HTTP;
     status: number;
+    /** @deprecated */
     body?: unknown;
     errorRef?: string;
+    cause?: any;
+    details?: any;
 }

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;
+};