@dynatrace-sdk/client-query 1.11.1 → 1.13.0

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dynatrace-sdk/client-query",
-  "version": "1.11.1",
+  "version": "1.13.0",
   "description": "Exposes an API to fetch records stored in Grail.",
   "license": "Apache-2.0",
   "dependencies": {
     "@dynatrace-sdk/error-handlers": "^1.2.0",
-    "@dynatrace-sdk/http-client": "^1.0.10"
+    "@dynatrace-sdk/http-client": "^1.3.0"
   },
   "main": "./cjs/index.js",
   "module": "./esm/index.js",

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

@@ -4,6 +4,7 @@ import { ErrorType } from '@dynatrace-sdk/error-handlers';
  */
 export declare class ApiClientError extends Error {
     readonly cause?: any;
+    readonly isApiClientError = true;
     errorType: ErrorType;
     constructor(name: string, message?: string, cause?: any);
 }

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

@@ -1,6 +1,7 @@
 import { HttpClientResponse } from '@dynatrace-sdk/http-client';
 import { ApiClientError } from './api-client-error';
 export declare class ClientRequestError<DTO> extends ApiClientError {
+    readonly isClientRequestError = true;
     body: DTO;
     response: HttpClientResponse;
     constructor(name: string, response: HttpClientResponse, body: DTO, message?: string, cause?: any);

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

@@ -4,5 +4,6 @@
 import { ClientRequestError } from './client-request-error';
 import { ErrorEnvelope } from '../models';
 export declare class ErrorEnvelopeError extends ClientRequestError<ErrorEnvelope> {
+    readonly isErrorEnvelopeError = true;
 }
 export declare function isErrorEnvelopeError(e: any): e is ErrorEnvelopeError;

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

@@ -1,5 +1,6 @@
 import { ApiClientError } from './api-client-error';
 export declare class InvalidResponseError extends ApiClientError {
+    readonly isInvalidResponseError = true;
     responseBody: any;
     expectedType?: string;
     nestedError?: Error;

package/types/packages/client/query/src/lib/models/autocomplete-suggestion.d.ts

@@ -8,7 +8,7 @@ export interface AutocompleteSuggestion {
      */
     parts: AutocompleteSuggestionPart[];
     /**
-     * Number of characters that the user user already typed for this suggestion.
+     * Number of characters that the user already typed for this suggestion.
      */
     alreadyTypedCharacters: number;
     /**

package/types/packages/client/query/src/lib/models/error-response-details-constraint-violations-item.d.ts

@@ -0,0 +1,14 @@
+export interface ErrorResponseDetailsConstraintViolationsItem {
+    /**
+     * Message describing the error.
+     */
+    message: string;
+    /**
+     * Describes the general location of the violating parameter.
+     */
+    parameterLocation?: string;
+    /**
+     * Describes the violating parameter.
+     */
+    parameterDescriptor?: string;
+}

package/types/packages/client/query/src/lib/models/error-response-details-constraint-violations-item.transformation.d.ts

@@ -0,0 +1,10 @@
+import { ErrorResponseDetailsConstraintViolationsItem } from './error-response-details-constraint-violations-item';
+export interface AsJson {
+    message: string;
+    parameterLocation?: string;
+    parameterDescriptor?: string;
+}
+export declare function isErrorResponseDetailsConstraintViolationsItem(value: any): value is ErrorResponseDetailsConstraintViolationsItem;
+export declare function isJson(value: any): value is AsJson;
+export declare function fromJson($model: AsJson): ErrorResponseDetailsConstraintViolationsItem;
+export declare function toJson($model: ErrorResponseDetailsConstraintViolationsItem): AsJson;

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

@@ -1,3 +1,4 @@
+import { ErrorResponseDetailsConstraintViolationsItem } from './error-response-details-constraint-violations-item';
 import { TokenPosition } from './token-position';
 /**
  * Detailed information about the error.
@@ -6,31 +7,43 @@ export interface ErrorResponseDetails {
     /**
      * The exception type.
      */
-    exceptionType: string;
+    exceptionType?: string;
     syntaxErrorPosition?: TokenPosition;
     /**
      * The error type, e.g. COMMAND_NAME_MISSING
      */
-    errorType: string;
+    errorType?: string;
     /**
      * Complete error message.
      */
-    errorMessage: string;
+    errorMessage?: string;
     /**
      * The arguments for the message format.
      */
-    arguments: string[];
+    arguments?: string[];
     /**
      * Submitted query string.
      */
-    queryString: string;
+    queryString?: string;
     /**
      * The corresponding DQL format specifier types for each format specifier used in the error message format.
      */
-    errorMessageFormatSpecifierTypes: string[];
+    errorMessageFormatSpecifierTypes?: string[];
     /**
      * The message format of the error message, string.format based.
      */
-    errorMessageFormat: string;
+    errorMessageFormat?: string;
     queryId?: string;
+    /**
+     * Information about an input parameter that violated some validation rule of the service API.
+     */
+    constraintViolations?: ErrorResponseDetailsConstraintViolationsItem[];
+    /**
+     * List of missing IAM scopes necessary to successfully execute the request.
+     */
+    missingScopes?: string[];
+    /**
+     * List of missing IAM permissions necessary to successfully execute the request.
+     */
+    missingPermissions?: string[];
 }

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

@@ -1,15 +1,19 @@
 import { ErrorResponseDetails } from './error-response-details';
+import * as _ErrorResponseDetailsConstraintViolationsItemTransformation from './error-response-details-constraint-violations-item.transformation';
 import * as _TokenPositionTransformation from './token-position.transformation';
 export interface AsJson {
-    exceptionType: string;
+    exceptionType?: string;
     syntaxErrorPosition?: _TokenPositionTransformation.AsJson;
-    errorType: string;
-    errorMessage: string;
-    arguments: string[];
-    queryString: string;
-    errorMessageFormatSpecifierTypes: string[];
-    errorMessageFormat: string;
+    errorType?: string;
+    errorMessage?: string;
+    arguments?: string[];
+    queryString?: string;
+    errorMessageFormatSpecifierTypes?: string[];
+    errorMessageFormat?: string;
     queryId?: string;
+    constraintViolations?: _ErrorResponseDetailsConstraintViolationsItemTransformation.AsJson[];
+    missingScopes?: string[];
+    missingPermissions?: string[];
 }
 export declare function isErrorResponseDetails(value: any): value is ErrorResponseDetails;
 export declare function isJson(value: any): value is AsJson;

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

@@ -7,7 +7,7 @@ export interface ErrorResponse {
      * A short, clear error message without details
      */
     message: string;
-    details: ErrorResponseDetails;
+    details?: ErrorResponseDetails;
     /**
      * Error code, which normally matches the HTTP error code.
      */

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

@@ -2,7 +2,7 @@ import { ErrorResponse } from './error-response';
 import * as _ErrorResponseDetailsTransformation from './error-response-details.transformation';
 export interface AsJson {
     message: string;
-    details: _ErrorResponseDetailsTransformation.AsJson;
+    details?: _ErrorResponseDetailsTransformation.AsJson;
     code: number;
 }
 export declare function isErrorResponse(value: any): value is ErrorResponse;

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

@@ -1,3 +1,4 @@
+import { FilterSegments } from './filter-segments';
 import { QueryOptions } from './query-options';
 export interface ExecuteRequest {
     /**
@@ -49,4 +50,5 @@ export interface ExecuteRequest {
      */
     defaultScanLimitGbytes?: number;
     queryOptions?: QueryOptions;
+    filterSegments?: FilterSegments;
 }

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

@@ -1,4 +1,5 @@
 import { ExecuteRequest } from './execute-request';
+import * as _FilterSegmentsTransformation from './filter-segments.transformation';
 import * as _QueryOptionsTransformation from './query-options.transformation';
 export interface AsJson {
     query: string;
@@ -14,6 +15,7 @@ export interface AsJson {
     defaultSamplingRatio?: number;
     defaultScanLimitGbytes?: number;
     queryOptions?: _QueryOptionsTransformation.AsJson;
+    filterSegments?: _FilterSegmentsTransformation.AsJson;
 }
 export declare function isExecuteRequest(value: any): value is ExecuteRequest;
 export declare function isJson(value: any): value is AsJson;

package/types/packages/client/query/src/lib/models/filter-segment-variable-definition.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Defines a variable with a name and a list of values.
+ */
+export interface FilterSegmentVariableDefinition {
+    name: string;
+    values: string[];
+}

package/types/packages/client/query/src/lib/models/filter-segment-variable-definition.transformation.d.ts

@@ -0,0 +1,9 @@
+import { FilterSegmentVariableDefinition } from './filter-segment-variable-definition';
+export interface AsJson {
+    name: string;
+    values: string[];
+}
+export declare function isFilterSegmentVariableDefinition(value: any): value is FilterSegmentVariableDefinition;
+export declare function isJson(value: any): value is AsJson;
+export declare function fromJson($model: AsJson): FilterSegmentVariableDefinition;
+export declare function toJson($model: FilterSegmentVariableDefinition): AsJson;

package/types/packages/client/query/src/lib/models/filter-segment.d.ts

@@ -0,0 +1,8 @@
+import { FilterSegmentVariableDefinition } from './filter-segment-variable-definition';
+/**
+ * A filter segment is identified by an ID. Each segment includes a list of variable definitions.
+ */
+export interface FilterSegment {
+    id: string;
+    variables?: FilterSegmentVariableDefinition[];
+}

package/types/packages/client/query/src/lib/models/filter-segment.transformation.d.ts

@@ -0,0 +1,10 @@
+import { FilterSegment } from './filter-segment';
+import * as _FilterSegmentVariableDefinitionTransformation from './filter-segment-variable-definition.transformation';
+export interface AsJson {
+    id: string;
+    variables?: _FilterSegmentVariableDefinitionTransformation.AsJson[];
+}
+export declare function isFilterSegment(value: any): value is FilterSegment;
+export declare function isJson(value: any): value is AsJson;
+export declare function fromJson($model: AsJson): FilterSegment;
+export declare function toJson($model: FilterSegment): AsJson;

package/types/packages/client/query/src/lib/models/filter-segments.d.ts

@@ -0,0 +1,6 @@
+import { FilterSegment } from './filter-segment';
+/**
+ * Represents a collection of filter segments.
+ */
+export interface FilterSegments extends Array<FilterSegment> {
+}

package/types/packages/client/query/src/lib/models/filter-segments.transformation.d.ts

@@ -0,0 +1,6 @@
+import * as _FilterSegmentTransformation from './filter-segment.transformation';
+import { FilterSegments } from './filter-segments';
+export interface AsJson extends Array<_FilterSegmentTransformation.AsJson> {
+}
+export declare function fromJson($model: AsJson): FilterSegments;
+export declare function toJson($model: FilterSegments): AsJson;

package/types/packages/client/query/src/lib/models/index.d.ts

@@ -22,12 +22,20 @@ export * from './error-response';
 export * as _ErrorResponseTransformation from './error-response.transformation';
 export * from './error-response-details';
 export * as _ErrorResponseDetailsTransformation from './error-response-details.transformation';
+export * from './error-response-details-constraint-violations-item';
+export * as _ErrorResponseDetailsConstraintViolationsItemTransformation from './error-response-details-constraint-violations-item.transformation';
 export * from './execute-request';
 export * as _ExecuteRequestTransformation from './execute-request.transformation';
 export * from './field-type';
 export * as _FieldTypeTransformation from './field-type.transformation';
 export * from './field-type-type';
 export * as _FieldTypeTypeTransformation from './field-type-type.transformation';
+export * from './filter-segment';
+export * as _FilterSegmentTransformation from './filter-segment.transformation';
+export * from './filter-segment-variable-definition';
+export * as _FilterSegmentVariableDefinitionTransformation from './filter-segment-variable-definition.transformation';
+export * from './filter-segments';
+export * as _FilterSegmentsTransformation from './filter-segments.transformation';
 export * from './geo-point';
 export * as _GeoPointTransformation from './geo-point.transformation';
 export * from './grail-metadata';

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

@@ -1,5 +1,5 @@
 /**
- * Query options.
+ * Query options enhance query functionality for Dynatrace internal services.
  */
 export interface QueryOptions {
     [propName: string]: string | undefined;

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

@@ -1,7 +1,8 @@
 /**
  * Represents a signal object that allows to communicate with the request and abort it using the `AbortController`.
+ * @deprecated Will be removed from HttpClient. We encourage using native interface for AbortSignal.
  */
-export interface AbortSignal extends EventTarget {
+interface HttpClientAbortSignal extends EventTarget {
     readonly reason: any;
     throwIfAborted(): void;
     /**
@@ -13,3 +14,5 @@ export interface AbortSignal extends EventTarget {
      */
     onabort: ((this: AbortSignal, event: Event) => void) | null;
 }
+export type AbortSignal = HttpClientAbortSignal | globalThis.AbortSignal;
+export {};