@dynatrace-sdk/client-query 1.10.1 → 1.11.0

package/esm/index.js

@@ -118,6 +118,8 @@ function serializeData(data) {
 function getMessagesFromErrorDetails(details) {
   const messages = [];
   Object.entries(details).forEach(([name, data]) => {
+    if (!data)
+      return;
     const serializedData = serializeData(data);
     switch (name) {
       case "missingScopes":
@@ -1333,10 +1335,10 @@ function isVerifyRequest(value) {
   if (Array.isArray(value)) {
     return false;
   }
-  const modelKeys = /* @__PURE__ */ new Set(["query", "timezone", "locale", "queryOptions"]);
+  const modelKeys = /* @__PURE__ */ new Set(["query", "timezone", "locale", "queryOptions", "generateCanonicalQuery"]);
   const hasAdditionalProperties = false;
   const requiredKeys = ["query"];
-  const optionalKeys = ["timezone", "locale", "queryOptions"];
+  const optionalKeys = ["timezone", "locale", "queryOptions", "generateCanonicalQuery"];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
   const doesNotContainExtraKeys = [...valKeys].every((key) => modelKeys.has(key)) || hasAdditionalProperties;
@@ -1353,10 +1355,10 @@ function isJson18(value) {
   if (Array.isArray(value)) {
     return false;
   }
-  const modelKeys = /* @__PURE__ */ new Set(["query", "timezone", "locale", "queryOptions"]);
+  const modelKeys = /* @__PURE__ */ new Set(["query", "timezone", "locale", "queryOptions", "generateCanonicalQuery"]);
   const hasAdditionalProperties = false;
   const requiredKeys = ["query"];
-  const optionalKeys = ["timezone", "locale", "queryOptions"];
+  const optionalKeys = ["timezone", "locale", "queryOptions", "generateCanonicalQuery"];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
   const doesNotContainExtraKeys = [...valKeys].every((key) => modelKeys.has(key)) || hasAdditionalProperties;
@@ -1364,21 +1366,23 @@ function isJson18(value) {
   return containsRequiredOrOptionalKeys && doesNotContainExtraKeys && allPropertiesMatchFormat;
 }
 function fromJson18($model) {
-  const { query, timezone, locale, queryOptions } = $model;
+  const { query, timezone, locale, queryOptions, generateCanonicalQuery } = $model;
   return {
     query,
     timezone,
     locale,
-    queryOptions: queryOptions !== void 0 && queryOptions !== null ? fromJson(queryOptions) : void 0
+    queryOptions: queryOptions !== void 0 && queryOptions !== null ? fromJson(queryOptions) : void 0,
+    generateCanonicalQuery
   };
 }
 function toJson18($model) {
-  const { query, timezone, locale, queryOptions } = $model;
+  const { query, timezone, locale, queryOptions, generateCanonicalQuery } = $model;
   return {
     query,
     timezone,
     locale,
-    queryOptions: queryOptions !== void 0 && queryOptions !== null ? toJson(queryOptions) : void 0
+    queryOptions: queryOptions !== void 0 && queryOptions !== null ? toJson(queryOptions) : void 0,
+    generateCanonicalQuery
   };
 }
 
@@ -1523,10 +1527,10 @@ function isVerifyResponse(value) {
   if (Array.isArray(value)) {
     return false;
   }
-  const modelKeys = /* @__PURE__ */ new Set(["valid", "notifications"]);
+  const modelKeys = /* @__PURE__ */ new Set(["valid", "canonicalQuery", "notifications"]);
   const hasAdditionalProperties = false;
   const requiredKeys = ["valid"];
-  const optionalKeys = ["notifications"];
+  const optionalKeys = ["canonicalQuery", "notifications"];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
   const doesNotContainExtraKeys = [...valKeys].every((key) => modelKeys.has(key)) || hasAdditionalProperties;
@@ -1543,10 +1547,10 @@ function isJson20(value) {
   if (Array.isArray(value)) {
     return false;
   }
-  const modelKeys = /* @__PURE__ */ new Set(["valid", "notifications"]);
+  const modelKeys = /* @__PURE__ */ new Set(["valid", "canonicalQuery", "notifications"]);
   const hasAdditionalProperties = false;
   const requiredKeys = ["valid"];
-  const optionalKeys = ["notifications"];
+  const optionalKeys = ["canonicalQuery", "notifications"];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
   const doesNotContainExtraKeys = [...valKeys].every((key) => modelKeys.has(key)) || hasAdditionalProperties;
@@ -1554,16 +1558,18 @@ function isJson20(value) {
   return containsRequiredOrOptionalKeys && doesNotContainExtraKeys && allPropertiesMatchFormat;
 }
 function fromJson20($model) {
-  const { valid, notifications } = $model;
+  const { valid, canonicalQuery, notifications } = $model;
   return {
     valid,
+    canonicalQuery,
     notifications: notifications !== void 0 && notifications !== null ? notifications?.map((innerValue) => fromJson19(innerValue)) : void 0
   };
 }
 function toJson20($model) {
-  const { valid, notifications } = $model;
+  const { valid, canonicalQuery, notifications } = $model;
   return {
     valid,
+    canonicalQuery,
     notifications: notifications !== void 0 && notifications !== null ? notifications?.map((innerValue) => toJson19(innerValue)) : void 0
   };
 }
@@ -1580,9 +1586,6 @@ var QueryAssistanceClient = class {
       throw new ApiClientError("API client error", "API client call is missing mandatory config parameter");
     }
     const encodedBody = toJson18(config.body);
-    const headerParameters = {
-      ...config.authorization !== void 0 && { Authorization: String(config.authorization) }
-    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:verify`,
@@ -1591,8 +1594,7 @@ var QueryAssistanceClient = class {
         body: encodedBody,
         headers: {
           "Content-Type": "application/json",
-          Accept: "application/json",
-          ...headerParameters
+          Accept: "application/json"
         },
         abortSignal: config.abortSignal,
         statusValidator: (status) => {
@@ -1625,7 +1627,7 @@ var QueryAssistanceClient = class {
           try {
             const errorBody = fromJson16(responseValue);
             throw new ErrorEnvelopeError(
-              "400",
+              `400`,
               response,
               errorBody,
               getErrorMessage(errorBody, "The supplied request is wrong."),
@@ -1649,7 +1651,7 @@ var QueryAssistanceClient = class {
           try {
             const errorBody = fromJson16(responseValue);
             throw new ErrorEnvelopeError(
-              "500",
+              `500`,
               response,
               errorBody,
               getErrorMessage(errorBody, "An internal server error has occurred."),
@@ -1686,9 +1688,6 @@ var QueryAssistanceClient = class {
       throw new ApiClientError("API client error", "API client call is missing mandatory config parameter");
     }
     const encodedBody = toJson17(config.body);
-    const headerParameters = {
-      ...config.authorization !== void 0 && { Authorization: String(config.authorization) }
-    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:parse`,
@@ -1697,8 +1696,7 @@ var QueryAssistanceClient = class {
         body: encodedBody,
         headers: {
           "Content-Type": "application/json",
-          Accept: "application/json",
-          ...headerParameters
+          Accept: "application/json"
         },
         abortSignal: config.abortSignal,
         statusValidator: (status) => {
@@ -1731,7 +1729,7 @@ var QueryAssistanceClient = class {
           try {
             const errorBody = fromJson16(responseValue);
             throw new ErrorEnvelopeError(
-              "400",
+              `400`,
               response,
               errorBody,
               getErrorMessage(
@@ -1758,7 +1756,7 @@ var QueryAssistanceClient = class {
           try {
             const errorBody = fromJson16(responseValue);
             throw new ErrorEnvelopeError(
-              "500",
+              `500`,
               response,
               errorBody,
               getErrorMessage(errorBody, "An internal server error has occurred."),
@@ -1795,9 +1793,6 @@ var QueryAssistanceClient = class {
       throw new ApiClientError("API client error", "API client call is missing mandatory config parameter");
     }
     const encodedBody = toJson2(config.body);
-    const headerParameters = {
-      ...config.authorization !== void 0 && { Authorization: String(config.authorization) }
-    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:autocomplete`,
@@ -1806,8 +1801,7 @@ var QueryAssistanceClient = class {
         body: encodedBody,
         headers: {
           "Content-Type": "application/json",
-          Accept: "application/json",
-          ...headerParameters
+          Accept: "application/json"
         },
         abortSignal: config.abortSignal,
         statusValidator: (status) => {
@@ -1840,7 +1834,7 @@ var QueryAssistanceClient = class {
           try {
             const errorBody = fromJson16(responseValue);
             throw new ErrorEnvelopeError(
-              "400",
+              `400`,
               response,
               errorBody,
               getErrorMessage(
@@ -1867,7 +1861,7 @@ var QueryAssistanceClient = class {
           try {
             const errorBody = fromJson16(responseValue);
             throw new ErrorEnvelopeError(
-              "500",
+              `500`,
               response,
               errorBody,
               getErrorMessage(errorBody, "An internal server error has occurred."),
@@ -3287,7 +3281,7 @@ var QueryExecutionClient = class {
           try {
             const errorBody = fromJson16(responseValue);
             throw new ErrorEnvelopeError(
-              "400",
+              `400`,
               response,
               errorBody,
               getErrorMessage(
@@ -3323,7 +3317,7 @@ var QueryExecutionClient = class {
           try {
             const errorBody = fromJson16(responseValue);
             throw new ErrorEnvelopeError(
-              "500",
+              `500`,
               response,
               errorBody,
               getErrorMessage(errorBody, "An internal server error has occurred."),
@@ -3361,9 +3355,6 @@ var QueryExecutionClient = class {
     }
     const encodedBody = toJson21(config.body);
     const query = toQueryString({ enrich: config.enrich });
-    const headerParameters = {
-      ...config.authorization !== void 0 && { Authorization: String(config.authorization) }
-    };
     try {
       const response = await this.httpClient.send({
         url: `/platform/storage/query/v1/query:execute${query}`,
@@ -3372,8 +3363,7 @@ var QueryExecutionClient = class {
         body: encodedBody,
         headers: {
           "Content-Type": "application/json",
-          Accept: "application/json",
-          ...headerParameters
+          Accept: "application/json"
         },
         abortSignal: config.abortSignal,
         statusValidator: (status) => {
@@ -3433,7 +3423,7 @@ var QueryExecutionClient = class {
           try {
             const errorBody = fromJson16(responseValue);
             throw new ErrorEnvelopeError(
-              "400",
+              `400`,
               response,
               errorBody,
               getErrorMessage(
@@ -3460,7 +3450,7 @@ var QueryExecutionClient = class {
           try {
             const errorBody = fromJson16(responseValue);
             throw new ErrorEnvelopeError(
-              "403",
+              `403`,
               response,
               errorBody,
               getErrorMessage(errorBody, "Insufficient permissions."),
@@ -3484,7 +3474,7 @@ var QueryExecutionClient = class {
           try {
             const errorBody = fromJson16(responseValue);
             throw new ErrorEnvelopeError(
-              "429",
+              `429`,
               response,
               errorBody,
               getErrorMessage(errorBody, "Too many requests."),
@@ -3508,7 +3498,7 @@ var QueryExecutionClient = class {
           try {
             const errorBody = fromJson16(responseValue);
             throw new ErrorEnvelopeError(
-              "500",
+              `500`,
               response,
               errorBody,
               getErrorMessage(errorBody, "An internal server error has occurred."),
@@ -3532,7 +3522,7 @@ var QueryExecutionClient = class {
           try {
             const errorBody = fromJson16(responseValue);
             throw new ErrorEnvelopeError(
-              "503",
+              `503`,
               response,
               errorBody,
               getErrorMessage(errorBody, "Service is unavailable."),
@@ -3556,13 +3546,19 @@ var QueryExecutionClient = class {
             const responseValue = await response.body("json");
             try {
               const errorBody = fromJson16(responseValue);
-              throw new ErrorEnvelopeError("4XX", response, errorBody, getErrorMessage(errorBody, "Client error."), e);
+              throw new ErrorEnvelopeError(
+                `${response.status}`,
+                response,
+                errorBody,
+                getErrorMessage(errorBody, "Client error."),
+                e
+              );
             } catch (err) {
               if (err instanceof ErrorEnvelopeError) {
                 throw err;
               }
               throw new InvalidResponseError(
-                `QueryExecutionClient.query:execute:4XX`,
+                `QueryExecutionClient.query:execute:${response.status}`,
                 err,
                 responseValue,
                 "ErrorEnvelope",
@@ -3573,13 +3569,19 @@ var QueryExecutionClient = class {
             const responseValue = await response.body("json");
             try {
               const errorBody = fromJson16(responseValue);
-              throw new ErrorEnvelopeError("5XX", response, errorBody, getErrorMessage(errorBody, "Server error."), e);
+              throw new ErrorEnvelopeError(
+                `${response.status}`,
+                response,
+                errorBody,
+                getErrorMessage(errorBody, "Server error."),
+                e
+              );
             } catch (err) {
               if (err instanceof ErrorEnvelopeError) {
                 throw err;
               }
               throw new InvalidResponseError(
-                `QueryExecutionClient.query:execute:5XX`,
+                `QueryExecutionClient.query:execute:${response.status}`,
                 err,
                 responseValue,
                 "ErrorEnvelope",
@@ -3664,7 +3666,7 @@ var QueryExecutionClient = class {
           try {
             const errorBody = fromJson16(responseValue);
             throw new ErrorEnvelopeError(
-              "400",
+              `400`,
               response,
               errorBody,
               getErrorMessage(
@@ -3700,7 +3702,7 @@ var QueryExecutionClient = class {
           try {
             const errorBody = fromJson16(responseValue);
             throw new ErrorEnvelopeError(
-              "500",
+              `500`,
               response,
               errorBody,
               getErrorMessage(errorBody, "An internal server error has occurred."),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynatrace-sdk/client-query",
-  "version": "1.10.1",
+  "version": "1.11.0",
   "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

@@ -40,7 +40,6 @@ export declare class QueryAssistanceClient {
      */
     queryVerify(config: {
         body: VerifyRequest;
-        /** The authorization context. Typically start with 'Bearer '. */ authorization?: string;
         abortSignal?: AbortSignal;
     }): Promise<VerifyResponse>;
     /**
@@ -252,7 +251,6 @@ export declare class QueryAssistanceClient {
      */
     queryParse(config: {
         body: ParseRequest;
-        /** The authorization context. Typically start with 'Bearer '. */ authorization?: string;
         abortSignal?: AbortSignal;
     }): Promise<DQLNode>;
     /**
@@ -308,7 +306,6 @@ export declare class QueryAssistanceClient {
      */
     queryAutocomplete(config: {
         body: AutocompleteRequest;
-        /** The authorization context. Typically start with 'Bearer '. */ authorization?: string;
         abortSignal?: AbortSignal;
     }): Promise<AutocompleteResponse>;
 }

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

@@ -118,7 +118,6 @@ export declare class QueryExecutionClient {
     queryExecute(config: {
         body: ExecuteRequest;
         /** If set additional data will be available in the metadata section. */ enrich?: string;
-        /** The authorization context. Typically start with 'Bearer '. */ authorization?: string;
         abortSignal?: AbortSignal;
     }): Promise<QueryStartResponse>;
     /**

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

@@ -5,11 +5,11 @@ export interface ExecuteRequest {
      */
     query: string;
     /**
-     * The query timeframe 'start' timestamp in ISO-8601 or RFC399 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored. <em>Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.</em>
+     * The query timeframe 'start' timestamp in ISO-8601 or RFC3339 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored. <em>Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.</em>
      */
     defaultTimeframeStart?: string;
     /**
-     * The query timeframe 'end' timestamp in ISO-8601 or RFC399 format. If the timeframe 'start' parameter is missing, the whole timeframe is ignored. <em>Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.</em>
+     * The query timeframe 'end' timestamp in ISO-8601 or RFC3339 format. If the timeframe 'start' parameter is missing, the whole timeframe is ignored. <em>Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.</em>
      */
     defaultTimeframeEnd?: string;
     /**

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

@@ -13,4 +13,5 @@ export interface VerifyRequest {
      */
     locale?: string;
     queryOptions?: QueryOptions;
+    generateCanonicalQuery?: boolean;
 }

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

@@ -5,6 +5,7 @@ export interface AsJson {
     timezone?: string;
     locale?: string;
     queryOptions?: _QueryOptionsTransformation.AsJson;
+    generateCanonicalQuery?: boolean;
 }
 export declare function isVerifyRequest(value: any): value is VerifyRequest;
 export declare function isJson(value: any): value is AsJson;

package/types/packages/client/query/src/lib/models/verify-response.d.ts

@@ -7,6 +7,7 @@ export interface VerifyResponse {
      * True if the supplied DQL query string is valid.
      */
     valid: boolean;
+    canonicalQuery?: string;
     /**
      * The notifications related to the supplied DQL query string.
      */

package/types/packages/client/query/src/lib/models/verify-response.transformation.d.ts

@@ -2,6 +2,7 @@ import * as _MetadataNotificationTransformation from './metadata-notification.tr
 import { VerifyResponse } from './verify-response';
 export interface AsJson {
     valid: boolean;
+    canonicalQuery?: string;
     notifications?: _MetadataNotificationTransformation.AsJson[];
 }
 export declare function isVerifyResponse(value: any): value is VerifyResponse;

package/types/packages/http-client/src/index.d.ts

@@ -1,2 +1,2 @@
 export { AbortController, AbortSignal, BaseError, Binary, BinaryFormDataRequestField, BinaryFormDataResponseField, DataTypeError, DataTypes, FormDataRequestBody, FormDataRequestField, FormDataResponseBody, FormDataResponseField, Headers, HttpClient, HttpClientAbortError, HttpClientNetworkError, HttpClientRequestError, HttpClientRequestOptions, HttpClientResponse, HttpClientResponseError, JsonFormDataRequestField, RequestBodyTypes, ResponseBodyTypes, StatusValidator, TextFormDataRequestField, TextFormDataResponseField, UnsupportedOperationError, isHttpClientResponseError, isHttpClientAbortError, isHttpClientNetworkError, isHttpClientRequestError, } from './lib/types';
-export { AbortController as PlatformAbortController, AbortSignal as PlatformAbortSignal, BaseError as PlatformBaseError, Binary as PlatformBinary, DataTypeError as PlatformDataTypeError, HttpClient as PlatformHttpClient, HttpClientAbortError as PlatformHttpClientAbortError, HttpClientRequestError as PlatformHttpClientRequestError, HttpClientResponse as PlatformHttpClientResponse, HttpClientResponseError as PlatformHttpClientResponseError, UnsupportedOperationError as PlatformUnsupportedOperationError, httpClient, } from './lib/platform';
+export { AbortController as PlatformAbortController, AbortSignal as PlatformAbortSignal, BaseError as PlatformBaseError, Binary as PlatformBinary, DataTypeError as PlatformDataTypeError, HttpClient as PlatformHttpClient, HttpClientAbortError as PlatformHttpClientAbortError, HttpClientRequestError as PlatformHttpClientRequestError, HttpClientResponse as PlatformHttpClientResponse, HttpClientResponseError as PlatformHttpClientResponseError, OAuthHttpClient as _OAuthHttpClient, OAuthHttpClientConfig as _OAuthHttpClientConfig, UnsupportedOperationError as PlatformUnsupportedOperationError, httpClient, } from './lib/platform';

package/types/packages/http-client/src/lib/platform/http-client.d.ts

@@ -1,5 +1,16 @@
 import * as types from '../types';
+interface HttpClientConfiguration {
+    baseUrl?: string;
+}
 export declare class HttpClient implements types.HttpClient {
+    private _baseUrl;
+    constructor(options?: HttpClientConfiguration);
+    /**
+     * Sets HTTP Client Instance baseUrl param to the incoming value `baseUrl`.
+     * @param baseUrl  Base URL used in the request path.
+     */
+    _setBaseURL(baseUrl: string): void;
     send<T extends keyof types.RequestBodyTypes = 'json'>(options: types.HttpClientRequestOptions<T>): Promise<types.HttpClientResponse>;
 }
 export declare const httpClient: HttpClient;
+export {};

package/types/packages/http-client/src/lib/platform/index.d.ts

@@ -8,4 +8,5 @@ export * from './http-client-abort-error';
 export * from './http-client-request-error';
 export * from './http-client-response';
 export * from './http-client-response-error';
+export * from './oauth-http-client';
 export * from './unsupported-operation-error';

package/types/packages/http-client/src/lib/platform/oauth-http-client.d.ts

@@ -0,0 +1,41 @@
+import * as types from '../types';
+/**
+ * DO NOT USE - internal use only.
+ */
+export interface OAuthHttpClientConfig {
+    clientId: string;
+    secret: string;
+    scopes: string[];
+    environmentUrl: string;
+    authUrl: string;
+}
+export interface OAuthTokenResponse {
+    scope: string;
+    token_type: string;
+    expires_in: number;
+    access_token: string;
+}
+/**
+ * DO NOT USE - internal use only.
+ */
+export declare class OAuthToken {
+    private readonly _scope;
+    private readonly _tokenType;
+    private readonly _expirationDate;
+    private readonly _accessToken;
+    constructor(oauthTokenResponse: OAuthTokenResponse);
+    get scope(): string;
+    get tokenType(): string;
+    isExpired(): boolean;
+    get accessToken(): string;
+}
+/**
+ * DO NOT USE - internal use only.
+ */
+export declare class OAuthHttpClient implements types.HttpClient {
+    private readonly config;
+    private oauthToken?;
+    constructor(config: OAuthHttpClientConfig);
+    send<T extends keyof types.RequestBodyTypes = 'json'>(options: types.HttpClientRequestOptions<T>): Promise<types.HttpClientResponse>;
+    private requestToken;
+}