@dynatrace-sdk/client-query 1.0.0

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

@@ -0,0 +1,83 @@
+/// <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 declare type FormDataRequestField = TextFormDataRequestField | JsonFormDataRequestField | BinaryFormDataRequestField;
+/**
+ * Represents a multipart/form-data body.
+ */
+export declare type FormDataRequestBody = Array<FormDataRequestField>;

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

@@ -0,0 +1,15 @@
+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 declare type FormDataResponseField = TextFormDataResponseField | BinaryFormDataResponseField;
+export declare type FormDataResponseBody = Array<FormDataResponseField>;

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,42 @@
+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

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

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

@@ -0,0 +1,33 @@
+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 when the response body does not conform to the specified response body type.
+     * @throws UnsupportedOperationError when the 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

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,26 @@
+/// <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 declare 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

@@ -0,0 +1,46 @@
+/// <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 declare 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

@@ -0,0 +1,7 @@
+/**
+ * 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

@@ -0,0 +1,14 @@
+/**
+ * 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

@@ -0,0 +1,2 @@
+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

@@ -0,0 +1,13 @@
+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

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

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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,9 @@
+/**
+ * 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

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

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

@@ -0,0 +1,10 @@
+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 declare type GlobalErrorSerializer = (error: any) => Promise<SerializedError | undefined>;

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

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

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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,8 @@
+import { CommonSerializedError } from './common-serialized-error';
+import { HttpSerializedError } from './http-serialized-error';
+/**
+ * Serialized error object contains error type
+ *
+ * @property {ErrorType} type error type
+ */
+export declare type SerializedError = HttpSerializedError | CommonSerializedError;

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

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

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

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