@dynatrace-sdk/client-classic-environment-v2 4.2.1 → 5.2.2

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