@dynatrace-sdk/client-query 1.21.2 → 1.22.1

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