@dynatrace-sdk/client-query 1.22.0 → 1.22.1

package/CHANGELOG.md

@@ -2,11 +2,17 @@
 
 @dynatrace-sdk/client-query
 
+## 1.22.1
+
+Patch Changes
+- Improve description of query-api spec
+
 ## 1.22.0
 
 ### Minor Changes
--  Add new token types to the `TokenType` enum
--  Add new body parameter `includeContributions` to indicate whether contribution information should be included in the query response metadata.
+
+- Add new token types to the `TokenType` enum
+- Add new body parameter `includeContributions` to indicate whether contribution information should be included in the query response metadata.
 
 ## 1.21.3
 

package/README.md

@@ -1,6 +1,6 @@
 # @dynatrace-sdk/client-query
 
-[![npm](https://img.shields.io/badge/npm-v1.22.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.22.0)
+[![npm](https://img.shields.io/badge/npm-v1.22.1-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.22.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
@@ -914,7 +914,7 @@ Detailed information about the error.
 |defaultTimeframeStart|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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> |
 |enablePreview|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Request preview results. If a preview is available within the requestTimeoutMilliseconds, then it will be returned as part of the response. <i>default:</i> <code>false</code>|
 |enforceQueryConsumptionLimit|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean to indicate if the query consumption limit should be enforced |
-|fetchTimeoutSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The time limit for fetching data. Soft limit as further data processing can happen. No upper limit in API but application level default and maximum fetch timeout also applies. |
+|fetchTimeoutSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The time limit for fetching data. It is a  soft limit as further data processing can happen. This limit is configurable and subject to default (typically 300s) and maximum (typically 900s) values defined in the query engine. If the specified value exceeds the maximum allowed value, it will be automatically reduced to the maximum. |
 |filterSegments|<a href="#filtersegments" target="_blank" rel="noopener noreferrer">FilterSegments</a>|Represents a collection of filter segments. |
 |includeContributions|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Indicates whether bucket contribution information should be included in the query response metadata. When set to true, the response will contain details about how each bucket contributed to the query result. <i>default:</i> <code>false</code>|
 |includeTypes|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Parameter to exclude the type information from the query result. In case not specified, the type information will be included. <i>default:</i> <code>true</code>|

package/dynatrace-metadata.json

@@ -1,6 +1,6 @@
 {
   "dynagen": {
-    "version": "0.20.3",
+    "version": "0.20.5",
     "template": {
       "name": "@dynatrace-sdk/template-typescript-client",
       "version": "0.35.2"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynatrace-sdk/client-query",
-  "version": "1.22.0",
+  "version": "1.22.1",
   "description": "Exposes an API to fetch records stored in Grail.",
   "license": "Apache-2.0",
   "dependencies": {
@@ -10,4 +10,4 @@
   "main": "./cjs/index.js",
   "module": "./esm/index.js",
   "types": "./types/index.d.ts"
-}
+}

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

@@ -26,7 +26,7 @@ export interface ExecuteRequest {
      */
     enforceQueryConsumptionLimit?: boolean;
     /**
-     * The time limit for fetching data. Soft limit as further data processing can happen. No upper limit in API but application level default and maximum fetch timeout also applies.
+     * The time limit for fetching data. It is a  soft limit as further data processing can happen. This limit is configurable and subject to default (typically 300s) and maximum (typically 900s) values defined in the query engine. If the specified value exceeds the maximum allowed value, it will be automatically reduced to the maximum.
      */
     fetchTimeoutSeconds?: number;
     /**

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

@@ -1,2 +0,0 @@
-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, OAuthHttpClient as _OAuthHttpClient, OAuthHttpClientConfig as _OAuthHttpClientConfig, UnsupportedOperationError as PlatformUnsupportedOperationError, httpClient, } from './lib/platform';

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

@@ -1,6 +0,0 @@
-import * as types from '../types';
-declare const AbortController: {
-    new (): types.AbortController;
-};
-type AbortController = InstanceType<typeof AbortController>;
-export { AbortController };

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

@@ -1,6 +0,0 @@
-import * as types from '../types';
-declare const AbortSignal: {
-    new (): types.AbortSignal;
-};
-type AbortSignal = InstanceType<typeof AbortSignal>;
-export { AbortSignal };

package/types/packages/http-client/src/lib/platform/apply-content-type-header.d.ts

@@ -1,2 +0,0 @@
-import { Headers, RequestBodyTypes } from '../types';
-export declare function applyContentTypeHeader<T extends keyof RequestBodyTypes>(headers: Headers | undefined, requestBodyType: T): Headers | undefined;

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

@@ -1,5 +0,0 @@
-import * as types from '../types';
-export declare abstract class BaseError extends Error implements types.BaseError {
-    readonly cause?: any;
-    protected constructor(message: string, cause?: any);
-}

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

@@ -1,13 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import type * as stream from 'stream';
-import * as types from '../types';
-export declare class Binary implements types.Binary {
-    readonly data: Blob | ArrayBuffer | ReadableStream<Uint8Array>;
-    static fromText(text: string): Binary;
-    static fromJson(json: any): Binary;
-    static from(data: Blob | ArrayBuffer | ReadableStream<Uint8Array> | Buffer | stream.Readable): Binary;
-    private constructor();
-    get<T extends keyof types.DataTypes>(type: T): types.DataTypes[T];
-}
-export declare function isBinary(body: any): body is Binary;

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

@@ -1,6 +0,0 @@
-import * as types from '../types';
-import { BaseError } from './base-error';
-export declare class DataTypeError extends BaseError implements types.DataTypeError {
-    readonly name = "DataTypeError";
-    constructor(message: string, cause?: any);
-}

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

@@ -1,48 +0,0 @@
-export declare function isTextContentType(contentType: string): boolean;
-export declare function parseContentDisposition(contentDisposition: string): {
-    name: string;
-    fileName: string | undefined;
-};
-export declare function parseFormDataBoundary(contentType: string): string | undefined;
-export interface FormDataSection {
-    name: string;
-    headers: Record<string, string>;
-    rawData: Uint8Array;
-    text?: string;
-    file?: File;
-    fileName?: string;
-    payloadStartOffset?: number;
-    payloadEndOffset?: number;
-    headersStartOffset?: number;
-}
-export declare class FormDataParser {
-    private sourceArray;
-    private boundary;
-    private currentChar;
-    private currentByte;
-    offset: number;
-    private utf8Decoder;
-    constructor(sourceArray: Uint8Array, boundary: string);
-    get previousByte(): number | undefined;
-    get previousChar(): string | undefined;
-    private next;
-    charAt(offset: number): string | null;
-    nextChar(): string | null;
-    nextByte(): number | null;
-    get nextTwoChars(): string;
-    findNextBoundaryOffset(startOffset?: number): number | null;
-    skipPastNextBoundary(): boolean;
-    readLine(): Uint8Array | null;
-    readSectionHeaders(): {
-        headersLength: number;
-        headers: Record<string, string>;
-    };
-    extractData(): {
-        payloadStartOffset: number;
-        payloadEndOffset: number;
-        data: Uint8Array;
-    };
-    parse(): FormDataSection[];
-}
-export declare function isAppleBrowser(): boolean;
-export declare function parseMultipartFormDataResponse(response: Uint8Array, boundary: string): FormDataSection[];

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

@@ -1,3 +0,0 @@
-import * as types from '../types';
-import { ResponseBodyTypes } from '../types';
-export declare function decodeResponseBody<T extends keyof types.ResponseBodyTypes>(response: Response, responseBodyType: T): ResponseBodyTypes[T];

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

@@ -1,2 +0,0 @@
-import { StatusValidator } from '../types';
-export declare const defaultStatusValidator: StatusValidator;

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

@@ -1,2 +0,0 @@
-import { RequestBodyTypes } from '../types';
-export declare function encodeRequestBody<T extends keyof RequestBodyTypes>(body: RequestBodyTypes[T], requestBodyType: T): Promise<string | ArrayBuffer | Blob | ReadableStream<any> | FormData>;

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

@@ -1,7 +0,0 @@
-import * as types from '../types';
-export declare class HttpClientAbortError extends Error implements types.HttpClientAbortError {
-    readonly cause: any;
-    readonly name = "AbortError";
-    constructor(cause: any);
-}
-export declare const throwIfAbortError: (e: unknown) => void;

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

@@ -1,7 +0,0 @@
-import * as types from '../types';
-import { BaseError } from './base-error';
-export declare class HttpClientRequestError extends BaseError implements types.HttpClientRequestError {
-    readonly cause: any;
-    readonly name = "RequestError";
-    constructor(cause: any);
-}

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

@@ -1,3 +0,0 @@
-import { GlobalErrorSerializer } from '@dynatrace-sdk/error-handlers';
-export declare const httpClientResponseErrorSerializer: GlobalErrorSerializer;
-export declare function addHttpClientResponseErrorSerializer(): void;

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

@@ -1,11 +0,0 @@
-import * as types from '../types';
-import { HttpClientResponse } from './http-client-response';
-import { BaseError } from './base-error';
-export declare class HttpClientResponseError extends BaseError implements types.HttpClientResponseError {
-    readonly name = "ResponseError";
-    readonly response: HttpClientResponse;
-    readonly requestMethod?: string;
-    constructor(response: Response, data?: {
-        requestMethod?: string;
-    });
-}

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

@@ -1,10 +0,0 @@
-import * as types from '../types';
-export declare class HttpClientResponse implements types.HttpClientResponse {
-    private response;
-    constructor(response: Response);
-    get url(): string;
-    get status(): number;
-    get statusText(): string;
-    get headers(): types.Headers;
-    body<T extends keyof types.ResponseBodyTypes = 'json'>(responseBodyType?: T): types.ResponseBodyTypes[T];
-}

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

@@ -1,24 +0,0 @@
-import * as types from '../types';
-import { Headers } from '../types';
-interface HttpClientConfiguration {
-    baseUrl?: string;
-    defaultHeaders?: Headers;
-}
-export declare class HttpClient implements types.HttpClient {
-    private _baseUrl;
-    private _defaultHeaders;
-    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;
-    /**
-     * Sets HTTP Client Instance defaultHeaders param to the incoming value `defaultHeaders`.
-     * @param defaultHeaders  HTTP Headers to be used in outgoing requests.
-     */
-    _setDefaultHeaders(defaultHeaders: Headers): 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

@@ -1,12 +0,0 @@
-export * from './abort-controller';
-export * from './abort-signal';
-export * from './base-error';
-export * from './binary';
-export * from './data-type-error';
-export * from './http-client';
-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

@@ -1,41 +0,0 @@
-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;
-}

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

@@ -1,6 +0,0 @@
-import * as types from '../types';
-import { BaseError } from './base-error';
-export declare class UnsupportedOperationError extends BaseError implements types.UnsupportedOperationError {
-    readonly name = "UnsupportedOperationError";
-    constructor(message: string, cause?: any);
-}

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

@@ -1,14 +0,0 @@
-import { AbortSignal } from './abort-signal';
-/**
- * Represents a controller object that allows to abort one or more requests as and when desired.
- */
-export interface AbortController {
-    /**
-     * Aborts a request before it has completed.
-     */
-    abort(): void;
-    /**
-     * Returns an AbortSignal object instance, which can be used to communicate with a request.
-     */
-    signal: AbortSignal;
-}

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

@@ -1,18 +0,0 @@
-/**
- * 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.
- */
-interface HttpClientAbortSignal extends EventTarget {
-    readonly reason: any;
-    throwIfAborted(): void;
-    /**
-     * A flag indicating whether the requests the signal is communicating with are aborted.
-     */
-    readonly aborted: boolean;
-    /**
-     * Invoked when the requests the signal is communicating with are aborted.
-     */
-    onabort: ((this: AbortSignal, event: Event) => void) | null;
-}
-export type AbortSignal = HttpClientAbortSignal | globalThis.AbortSignal;
-export {};

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

@@ -1,4 +0,0 @@
-export interface BaseError extends Error {
-    readonly name: string;
-    readonly cause?: any;
-}

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

@@ -1,15 +0,0 @@
-import { DataTypes } from './data-types';
-/**
- * Represents an environment agnostic (browser vs node) abstraction layer for binary data.
- */
-export interface Binary {
-    /**
-     * Returns the binary data in a form that conforms to the specified type.
-     *
-     * @param type  The type of the data.
-     * Can be `text`, `json`, `array-buffer`, `blob`, `readable-stream`, `buffer` or `stream`.
-     * @throws {DataTypeError} Data does not conform to the specified type.
-     * @throws {UnsupportedOperationError} Type is not supported by the platform.
-     */
-    get<T extends keyof DataTypes>(type: T): DataTypes[T];
-}

package/types/packages/http-client/src/lib/types/data-type-error.d.ts

@@ -1,14 +0,0 @@
-/**
- * Represents a situation when the response body does not conform to the specified response body type.
- */
-import { BaseError } from './base-error';
-export interface DataTypeError extends BaseError {
-    /**
-     * The error name.
-     */
-    readonly name: 'DataTypeError';
-    /**
-     * The error root cause.
-     */
-    readonly cause?: any;
-}

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

@@ -1,36 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import type * as stream from 'stream';
-/**
- * Mapping between the data type names and types.
- */
-export type DataTypes = {
-    /**
-     * A text type.
-     */
-    text: Promise<string>;
-    /**
-     * A JSON type.
-     */
-    json: Promise<any>;
-    /**
-     * An ArrayBuffer type.
-     */
-    'array-buffer': Promise<ArrayBuffer>;
-    /**
-     * A Blob type. Browser only.
-     */
-    blob: Promise<Blob>;
-    /**
-     * A ReadableStream type. Browser only.
-     */
-    'readable-stream': ReadableStream<Uint8Array>;
-    /**
-     * A Buffer type. Node only.
-     */
-    buffer: Promise<Buffer>;
-    /**
-     * A Stream type. Node only.
-     */
-    stream: stream.Readable;
-};

package/types/packages/http-client/src/lib/types/form-data-request-body.d.ts

@@ -1,83 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import type * as stream from 'stream';
-import { Binary } from './binary';
-/**
- * Represents a plain text field. No filename and content type is set.
- */
-export interface TextFormDataRequestField {
-    /**
-     * A plain text field type discriminator.
-     */
-    type: 'text';
-    /**
-     * The name of the field.
-     */
-    name: string;
-    /**
-     * The field's value.
-     */
-    value: string;
-}
-/**
- * Represents a JSON field.
- */
-export interface JsonFormDataRequestField {
-    /**
-     * A JSON field type discriminator.
-     */
-    type: 'json';
-    /**
-     * The name of the field.
-     */
-    name: string;
-    /**
-     * The content type of the data contained in `value`.
-     * The default content type for the JSON is 'application/json'.
-     */
-    contentType?: string;
-    /**
-     * The filename reported to the server.
-     * The default filename for the JSON is 'json'.
-     */
-    filename?: string;
-    /**
-     * The field's value.
-     */
-    value: any;
-}
-/**
- * Represents an binary field.
- */
-export interface BinaryFormDataRequestField {
-    /**
-     * A binary field type discriminator.
-     */
-    type: 'binary';
-    /**
-     * The name of the field.
-     */
-    name: string;
-    /**
-     * The content type of the data contained in `value`.
-     * The default content type for the binary is 'application/octet-stream'.
-     */
-    contentType?: string;
-    /**
-     * The filename reported to the server.
-     * The default filename for the binary is 'binary'.
-     */
-    filename?: string;
-    /**
-     * The field's value.
-     */
-    value: ArrayBuffer | Blob | ReadableStream | Buffer | stream.Readable | Binary | File;
-}
-/**
- * Represents a multipart/form-data field.
- */
-export type FormDataRequestField = TextFormDataRequestField | JsonFormDataRequestField | BinaryFormDataRequestField;
-/**
- * Represents a multipart/form-data body.
- */
-export type FormDataRequestBody = Array<FormDataRequestField>;

package/types/packages/http-client/src/lib/types/form-data-response-body.d.ts

@@ -1,15 +0,0 @@
-import { Binary } from './binary';
-export interface TextFormDataResponseField {
-    type: 'text';
-    name: string;
-    value: string;
-}
-export interface BinaryFormDataResponseField {
-    type: 'binary';
-    name: string;
-    contentType: string;
-    filename: string;
-    value: Binary;
-}
-export type FormDataResponseField = TextFormDataResponseField | BinaryFormDataResponseField;
-export type FormDataResponseBody = Array<FormDataResponseField>;

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

@@ -1,6 +0,0 @@
-/**
- * Represents http headers.
- */
-export interface Headers {
-    [key: string]: string;
-}

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

@@ -1,15 +0,0 @@
-import { BaseError } from './base-error';
-/**
- * Represents a situation when the request was aborted.
- */
-export interface HttpClientAbortError extends BaseError {
-    /**
-     * The error name.
-     */
-    readonly name: 'AbortError';
-    /**
-     * The error root cause.
-     */
-    readonly cause?: any;
-}
-export declare function isHttpClientAbortError(e: any): e is HttpClientAbortError;

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

@@ -1,15 +0,0 @@
-import { BaseError } from './base-error';
-/**
- * Represents a situation when a network error occurred.
- */
-export interface HttpClientNetworkError extends BaseError {
-    /**
-     * The error name.
-     */
-    readonly name: 'NetworkError';
-    /**
-     * The error root cause.
-     */
-    readonly cause?: any;
-}
-export declare function isHttpClientNetworkError(e: any): e is HttpClientNetworkError;

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

@@ -1,15 +0,0 @@
-import { BaseError } from './base-error';
-/**
- * Represents a situation when the request is invalid and cannot be sent.
- */
-export interface HttpClientRequestError extends BaseError {
-    /**
-     * The error name.
-     */
-    readonly name: 'RequestError';
-    /**
-     * The error root cause.
-     */
-    readonly cause?: any;
-}
-export declare function isHttpClientRequestError(e: any): e is HttpClientRequestError;

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

@@ -1,42 +0,0 @@
-import { RequestBodyTypes } from './request-body-types';
-import { Headers } from './headers';
-import { AbortSignal } from './abort-signal';
-import { StatusValidator } from './status-validator';
-/**
- * Represents the options used to configure the request.
- */
-export interface HttpClientRequestOptions<T extends keyof RequestBodyTypes = 'json'> {
-    /**
-     * The URL of the resource to fetch.
-     */
-    url: string;
-    /**
-     * The request method, e.g. `GET`, `POST`.
-     */
-    method?: string;
-    /**
-     * The request headers.
-     */
-    headers?: Headers;
-    /**
-     * A request body that will be send along with the request.
-     * The structure of the request body needs to conform to the specified request body type.
-     */
-    body?: RequestBodyTypes[T];
-    /**
-     * The type of the request body. Can be `text`, `json`, `binary` or `form-data`.
-     * The default request body type is `json`.
-     */
-    requestBodyType?: T;
-    /**
-     * An AbortSignal instance that can be used to cancel the request.
-     */
-    abortSignal?: AbortSignal;
-    /**
-     * A custom status validator function.
-     * If the status validator function returns `true` the returned promise resolves with the `HttpClientResponse`
-     * Otherwise the promise rejects with the `StatusError`.
-     * The default status validator function considers the `2xx` status codes as valid.
-     */
-    statusValidator?: StatusValidator;
-}

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

@@ -1,20 +0,0 @@
-import { HttpClientResponse } from './http-client-response';
-import { BaseError } from './base-error';
-/**
- * Represents a situation when the response status is considered invalid by the status validator.
- */
-export interface HttpClientResponseError extends BaseError {
-    /**
-     * The error name.
-     */
-    readonly name: 'ResponseError';
-    /**
-     * The error root cause.
-     */
-    readonly cause?: any;
-    /**
-     * The response.
-     */
-    readonly response: HttpClientResponse;
-}
-export declare function isHttpClientResponseError(e: any): e is HttpClientResponseError;

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

@@ -1,33 +0,0 @@
-import { ResponseBodyTypes } from './response-body-types';
-import { Headers } from './headers';
-/**
- * Represents the response to a request.
- */
-export interface HttpClientResponse {
-    /**
-     * The URL of the response.
-     */
-    readonly url: string;
-    /**
-     * The status code of the response.
-     */
-    readonly status: number;
-    /**
-     * The status message corresponding to the status code.
-     */
-    readonly statusText: string;
-    /**
-     * The response headers.
-     */
-    readonly headers: Headers;
-    /**
-     * Returns the response body in a form that conforms to the specified response body type.
-     *
-     * @param responseBodyType  The type of the response body.
-     * Can be `text`, `json`, `binary`, `form-data`, `array-buffer`, `blob`, `readable-stream`, `buffer` or `stream`.
-     * The default response body type is `json`.
-     * @throws {DataTypeError} Response body does not conform to the specified response body type.
-     * @throws {UnsupportedOperationError} Response body type is not supported by the platform.
-     */
-    body<T extends keyof ResponseBodyTypes = 'json'>(responseBodyType?: T): ResponseBodyTypes[T];
-}

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

@@ -1,24 +0,0 @@
-import { RequestBodyTypes } from './request-body-types';
-import { HttpClientRequestOptions } from './http-client-request-options';
-import { HttpClientResponse } from './http-client-response';
-/**
- * The http client that serves as an environment agnostic (browser vs node) abstraction for making http calls.
- * It handles the authentication of the requests made to the Platform Services and the Serverless Functions.
- *
- * Currently, only the requests to the Platform Services and the Serverless Functions are supported.
- */
-export interface HttpClient {
-    /**
-     * Sends an http request as configured by the `options`.
-     * Returns a promise that resolves with a response object for successful requests or rejects with an appropriate error
-     * when one of the following situations happen:
-     * - `DataTypeError` - request body does not conform to the specified request body type,
-     * - `HttpClientRequestError` - request cannot be sent (e.g. due to network error or invalid request),
-     * - `HttpClientResponseError` - response status is considered invalid by the status validator,
-     * - `HttpClientAbortError` - request was aborted.
-     *
-     * @param options  Options used to configure the request.
-     * @return Promise<HttpClientResponse> A promise that resolves with the response object or rejects with an error.
-     */
-    send<T extends keyof RequestBodyTypes = 'json'>(options: HttpClientRequestOptions<T>): Promise<HttpClientResponse>;
-}

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

@@ -1,20 +0,0 @@
-export * from './base-error';
-export * from './http-client-request-error';
-export * from './unsupported-operation-error';
-export * from './status-validator';
-export * from './response-body-types';
-export * from './http-client';
-export * from './http-client-response';
-export * from './data-types';
-export * from './http-client-request-options';
-export * from './http-client-abort-error';
-export * from './abort-controller';
-export * from './form-data-response-body';
-export * from './abort-signal';
-export * from './http-client-response-error';
-export * from './form-data-request-body';
-export * from './binary';
-export * from './headers';
-export * from './request-body-types';
-export * from './data-type-error';
-export * from './http-client-network-error';

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

@@ -1,26 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { FormDataRequestBody } from './form-data-request-body';
-import type * as stream from 'stream';
-import { Binary } from './binary';
-/**
- * Mapping between the request body type names and types.
- */
-export type RequestBodyTypes = {
-    /**
-     * A text request body type.
-     */
-    text: string;
-    /**
-     * A JSON request body type.
-     */
-    json: any;
-    /**
-     * A multipart/form-data request body type.
-     */
-    'form-data': FormDataRequestBody;
-    /**
-     * A binary request body type.
-     */
-    binary: Binary | ArrayBuffer | Blob | ReadableStream | Buffer | stream.Readable;
-};

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

@@ -1,46 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import type * as stream from 'stream';
-import { FormDataResponseBody } from './form-data-response-body';
-import { Binary } from './binary';
-/**
- * Mapping between the response body type names and types.
- */
-export type ResponseBodyTypes = {
-    /**
-     * A text response body type.
-     */
-    text: Promise<string>;
-    /**
-     * A JSON response body type.
-     */
-    json: Promise<any>;
-    /**
-     * A binary body type.
-     */
-    binary: Promise<Binary>;
-    /**
-     * A multipart/form-data body type.
-     */
-    'form-data': Promise<FormDataResponseBody>;
-    /**
-     * An ArrayBuffer response body type.
-     */
-    'array-buffer': Promise<ArrayBuffer>;
-    /**
-     * A Blob response body type. Browser only.
-     */
-    blob: Promise<Blob>;
-    /**
-     * A ReadableStream response body type. Browser only.
-     */
-    'readable-stream': ReadableStream<Uint8Array>;
-    /**
-     * A Buffer response body type. Node only.
-     */
-    buffer: Promise<Buffer>;
-    /**
-     * A Stream response body type. Node only.
-     */
-    stream: stream.Readable;
-};

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

@@ -1,7 +0,0 @@
-/**
- * Represents a function used to validate the response status code.
- * If `true` is returned, the status is considered valid (request succeeded), otherwise it's considered invalid (request failed).
- */
-export interface StatusValidator {
-    (status: number): boolean;
-}

package/types/packages/http-client/src/lib/types/unsupported-operation-error.d.ts

@@ -1,14 +0,0 @@
-/**
- * Represents a situation when the requested operation is not supported.
- */
-import { BaseError } from './base-error';
-export interface UnsupportedOperationError extends BaseError {
-    /**
-     * The error name.
-     */
-    readonly name: 'UnsupportedOperationError';
-    /**
-     * The error root cause.
-     */
-    readonly cause?: any;
-}

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

@@ -1,2 +0,0 @@
-export * from './lib/add-global-error-serializer';
-export * from './lib/types';

package/types/packages/platform/error-handlers/src/lib/add-global-error-serializer.d.ts

@@ -1,13 +0,0 @@
-import { GlobalErrorSerializer } from './types/global-error-serializer';
-/**
- * Registers a global error serializer for handling uncatched errors.
- *
- * @param {GlobalErrorSerializer} serializer Asynchronous function which serializes error if it match the condition
- */
-export declare function addGlobalErrorSerializer(serializer: GlobalErrorSerializer): void;
-/**
- * Checks if global error serializer is supported.
- *
- * @return {boolean} information if global error serializer is supported on current environment.
- */
-export declare function isGlobalErrorSerializerSupported(): boolean;

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

@@ -1,13 +0,0 @@
-import { ErrorType } from './error-type';
-/**
- * Common serialized JS Error
- */
-export interface CommonSerializedError {
-    name: string;
-    message: string;
-    stack?: string;
-    type: ErrorType.COMMON;
-    errorRef?: string;
-    cause?: any;
-    details?: any;
-}

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

@@ -1,5 +0,0 @@
-import { GlobalErrorSerializer } from './global-error-serializer';
-/** @ignore */
-export interface DtRuntimeErrorHandlers {
-    addGlobalErrorSerializer(serializer: GlobalErrorSerializer): void;
-}

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

@@ -1,9 +0,0 @@
-/**
- * Possible serialized error types
- * `COMMON`: Common JS error
- * `HTTP`: Error thrown by a http-client
- */
-export declare enum ErrorType {
-    COMMON = "JS Error",
-    HTTP = "Http Error"
-}

package/types/packages/platform/error-handlers/src/lib/types/global-dt-runtime-with-error-handlers.d.ts

@@ -1,7 +0,0 @@
-import { DtRuntimeErrorHandlers } from './dt-runtime-error-handlers';
-/** @ignore */
-export type GlobalDtRuntimeWithErrorHandlers = typeof globalThis & {
-    dtRuntime?: {
-        errorHandlers?: DtRuntimeErrorHandlers;
-    };
-};

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

@@ -1,10 +0,0 @@
-import { SerializedError } from './serialized-error';
-/**
- * Custom error serializing function.
- * Should check the received error and, when the error matches, return a serialized error with the specified error type.
- * Otherwise, nothing should be returned so that the error can be handled further.
- *
- * @param {any} error Error to be serialized
- * @returns {TypedError | undefined} Serialized error or nothing
- */
-export type GlobalErrorSerializer = (error: any) => Promise<SerializedError | undefined>;

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

@@ -1,16 +0,0 @@
-import { ErrorType } from './error-type';
-/**
- * Serialized http exception with response status
- */
-export interface HttpSerializedError {
-    name: string;
-    message: string;
-    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/index.d.ts

@@ -1,6 +0,0 @@
-export * from './common-serialized-error';
-export * from './error-type';
-export * from './global-error-serializer';
-export * from './http-serialized-error';
-export * from './serialized-error';
-export * from './dt-runtime-error-handlers';

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

@@ -1,10 +0,0 @@
-import { CommonSerializedError } from './common-serialized-error';
-import { HttpSerializedError } from './http-serialized-error';
-/**
- * Serialized error object contains error type
- *
- * @property {ErrorType} type error type
- */
-export type SerializedError = (HttpSerializedError | CommonSerializedError) & {
-    traceId?: string;
-};

package/types/packages/platform/shared/index.d.ts

@@ -1 +0,0 @@
-export * from './utils/get-global-with-dt-runtime';

package/types/packages/platform/shared/utils/get-global-with-dt-runtime.d.ts

@@ -1 +0,0 @@
-export declare const getGlobalWithDtRuntime: <T extends typeof globalThis>() => T;

package/types/packages/shared-errors/src/api-client-error.d.ts

@@ -1,23 +0,0 @@
-import { ErrorType } from './types';
-/**
- * Base error for all client SDKs. All other errors extend this class.
- */
-export declare class ApiClientError extends Error {
-    readonly cause?: any;
-    readonly isApiClientError = true;
-    errorType: ErrorType;
-    constructor(name: string, message?: string, cause?: any);
-}
-/**
- * ApiClientError type guard function.
- * Does a structural check of the passed object.
- * @example
- * try {
- *   doSomething();
- * } catch (e: unknown) {
- *   if(isApiClientError(e)) {
- *     handleTheError();
- *   }
- * }
- */
-export declare function isApiClientError(e: any): e is ApiClientError;

package/types/packages/shared-errors/src/api-gateway-error.d.ts

@@ -1,37 +0,0 @@
-import { HttpClientResponse } from '@dynatrace-sdk/http-client';
-import { ClientRequestError } from './client-request-error';
-import { CommonApiError, CommonErrorDetails, ErrorResponseBody } from './types';
-export type ApiGatewayErrorResponseBody = ErrorResponseBody<CommonApiError<ApiGatewayErrorDetails> & {
-    retryAfterSeconds?: number;
-}>;
-/**
- * Reference for *ApiGatewayError* details object. Contains information about received API Getaway error.
- * */
-export interface ApiGatewayErrorDetails extends CommonErrorDetails {
-    errorCodeProperties?: {
-        [key: string]: string;
-    };
-}
-/**
- * Dedicated error response class for errors thrown by API Gateway.
- * Autogenerated SDK Clients have built-in handler for API Gateway errors that throws this error.
- */
-export declare class ApiGatewayError extends ClientRequestError<ApiGatewayErrorResponseBody> {
-    readonly isApiGatewayError = true;
-    readonly code: number;
-    readonly retryAfterSeconds: number | undefined;
-    constructor(response: HttpClientResponse, body: ApiGatewayErrorResponseBody);
-}
-/**
- * APIGatewayError type guard function.
- * Does a structural check of the passed object.
- * @example
- * try {
- *   doSomething();
- * } catch (e: unknown) {
- *   if(isApiClientError(e)) {
- *     handleTheError();
- *   }
- * }
- */
-export declare function isApiGatewayError(e: any): e is ApiGatewayError;

package/types/packages/shared-errors/src/client-request-error.d.ts

@@ -1,39 +0,0 @@
-import { HttpClientResponse } from '@dynatrace-sdk/http-client';
-import { ApiClientError } from './api-client-error';
-import { ErrorResponseBody } from './types';
-/**
- * Generic error class for service errors, used to handle both expected and unexpected service-level errors.
- * @example Handling unexpected error response, received by the SDK Client
- * const responseValue = await response.body('json');
- *
- * throw new ClientRequestError(
- *   `${response.status}`,
- *   response,
- *   responseValue,
- *   getErrorMessage(
- *     responseValue,
- *     `Unexpected api response: code=${response.status} body="${responseValue}"`,
- *   ),
- *   e,
- * );
- *
- */
-export declare class ClientRequestError<DTO = ErrorResponseBody> extends ApiClientError {
-    readonly isClientRequestError = true;
-    body: DTO;
-    response: HttpClientResponse;
-    constructor(name: string, response: HttpClientResponse, body: DTO, message?: string, cause?: any);
-}
-/**
- * ClientRequestError type guard function.
- * Does a structural check of the passed object.
- * @example
- * try {
- *   doSomething();
- * } catch (e: unknown) {
- *   if(isClientRequestError(e)) {
- *     handleTheError();
- *   }
- * }
- */
-export declare function isClientRequestError<T = ErrorResponseBody>(e: any): e is ClientRequestError<T>;

package/types/packages/shared-errors/src/index.d.ts

@@ -1,5 +0,0 @@
-export * from './api-client-error';
-export * from './api-gateway-error';
-export * from './client-request-error';
-export * from './invalid-response-error';
-export * from './types';

package/types/packages/shared-errors/src/invalid-response-error.d.ts

@@ -1,26 +0,0 @@
-import { ApiClientError } from './api-client-error';
-/**
- * Dedicated error class for errors related to response serialization.
- * Thrown when received service response can't be deserialized.
- **/
-export declare class InvalidResponseError extends ApiClientError {
-    readonly isInvalidResponseError = true;
-    responseBody: any;
-    expectedType?: string;
-    nestedError?: Error;
-    response: any;
-    constructor(name: string, nestedError: Error | any | undefined, body: any, expectedType?: string, message?: string, response?: any);
-}
-/**
- * InvalidResponseError type guard function.
- * Does a structural check of the passed object.
- * @example
- * try {
- *    doSomething();
- * } catch (e: unknown) {
- *    if (isInvalidResponseError(e)) {
- *      throw e;
- *    }
- * }
- */
-export declare function isInvalidResponseError(e: any): e is InvalidResponseError;

package/types/packages/shared-errors/src/types.d.ts

@@ -1,88 +0,0 @@
-/** @ignore*/
-export declare enum ErrorType {
-    COMMON = "JS Error",
-    HTTP = "Http Error"
-}
-/**
- * Basic error envelope, that enforces all error to have mandatory "error" property.
- * */
-export interface ErrorResponseBody<T = CommonApiError> {
-    /**
-     * *error* object must have two mandatory fields (*code, message*) and may have two additional fields (*help, details*):
-     * refer to the *CommonApiError* for more details.
-     * */
-    error: T;
-}
-/**
- * Common API error structure, established by Dynatrace API guidelines.
- * */
-export interface CommonApiError<T extends CommonErrorDetails & Record<string, any> = CommonErrorDetails & Record<string, any>> {
-    /** The error code should be set to the HTTP error code by default.<br>
-     * The error code may be set to an API-specific error code which must be properly documented.*/
-    code: number;
-    /** The error message should be short and precise, it should not contain details.*/
-    message: string;
-    /**
-     * An additional help field may be added which must be a URL to further information on how to deal with the error.<br>
-     * This may be some detailed error documentation page or a link to the Dynatrace support system, etc.
-     * */
-    help?: string;
-    /**
-     * Additional details about the error may be added in a details field.
-     * Refer to *CommonErrorDetails*
-     * */
-    details?: T;
-}
-/**
- * *CommonApiError* details object reference. Contains common API error information.
- *  This object is used to convey additional information about the error like e.g., which query parameter exactly violated a precondition. <br>
- *  Details may contain any fields to further describe the error
- * */
-export interface CommonErrorDetails {
-    /**
-     * UUID string that represents a reference of the error into e.g., the log file of the service.
-     * */
-    errorRef?: string;
-    /**
-     * String containing a 32-character hex integer value that is used for tracing.
-     * */
-    traceId?: string;
-    /**
-     * String value representing a more detailed error information than the http response code alone.
-     * Must be a single word in CamelCase, and all possible values must be documented.
-     * */
-    errorCode?: string;
-    /**
-     * An array of *ConstraintViolation* object, refer to ConstraintViolation object reference for more details.
-     * */
-    constraintViolations?: ConstraintViolation[];
-    /**
-     * Must be an array of strings containing a complete list of missing IAM scopes necessary to successfully execute the request.
-     * Should be set if the API returns a 403 - Forbidden response in case of missing OAuth scopes.
-     * */
-    missingScopes?: string[];
-    /**
-     * Must be an array of strings containing a complete list of missing IAM permissions necessary to successfully execute the request.
-     * Should be set if the API returns a 403 - Forbidden response in case of missing OAuth user permissions.
-     * */
-    missingPermissions?: string[];
-}
-/**
- * Contains information about an input parameter (path, query or request body)
- * that violated some validation rule of the service API and caused the warning.<br>
- * May contain additional fields further describing the warning.
- * */
-export interface ConstraintViolation extends Record<string, string | undefined> {
-    /**
-     * Mandatory field message describing the warning.
-     * */
-    message: string;
-    /**
-     * Describes the general location of the violating parameter (query parameter, request body, etc.)
-     */
-    parameterLocation?: string;
-    /**
-     * Refers to the violating parameter within the parameterLocation.
-     */
-    path?: string;
-}