@dynatrace-sdk/client-query 1.20.0 → 1.21.1

package/types/packages/client/query/src/lib/models/dql-terminal-node.d.ts

@@ -6,7 +6,7 @@ export interface DQLTerminalNode extends DQLNode {
     /**
      * The type of the autocomplete token.
      */
-    type?: 'SPACE' | 'LINEBREAK' | 'INDENT' | 'PIPE' | 'DOT' | 'COLON' | 'COMMA' | 'ASSIGNMENT' | 'BRACE_OPEN' | 'BRACE_CLOSE' | 'BRACKET_OPEN' | 'BRACKET_CLOSE' | 'PARENTHESIS_OPEN' | 'PARENTHESIS_CLOSE' | 'QUOTE' | 'SINGLE_QUOTE' | 'SLASH' | 'BOOLEAN_TRUE' | 'BOOLEAN_FALSE' | 'NULL' | 'COMMAND_NAME' | 'PARAMETER_KEY' | 'PARAMETER_VALUE_SCOPE' | 'FUNCTION_NAME' | 'TIMESERIES_AGGREGATION' | 'TIMESERIES_AGGREGATION_EXPRESSION' | 'OPERATOR' | 'SEARCH_OPERATOR' | 'TRAVERSAL_OPERATOR' | 'TRAVERSAL_RELATION_NAME' | 'TRAVERSAL_HOP_COUNT' | 'SIMPLE_IDENTIFIER' | 'DATA_OBJECT' | 'NUMBER' | 'STRING' | 'TIME_UNIT' | 'TIMESTAMP_VALUE' | 'METRIC_KEY' | 'VARIABLE' | 'END_COMMENT' | 'UID_VALUE' | 'PARSE_PATTERN' | 'FIELD_PATTERN' | 'SEARCH_PATTERN' | 'ENTITY_SELECTOR_PART' | 'SAVED_TABLE_NAME' | 'PARAMETER_MODIFIER' | 'FIELD_MODIFIER' | 'ENTITY_TYPE' | 'ENTITY_ATTRIBUTE' | 'SMARTSCAPE_ID_VALUE';
+    type?: 'SPACE' | 'LINEBREAK' | 'INDENT' | 'PIPE' | 'DOT' | 'COLON' | 'COMMA' | 'ASSIGNMENT' | 'BRACE_OPEN' | 'BRACE_CLOSE' | 'BRACKET_OPEN' | 'BRACKET_CLOSE' | 'PARENTHESIS_OPEN' | 'PARENTHESIS_CLOSE' | 'QUOTE' | 'SINGLE_QUOTE' | 'SLASH' | 'BOOLEAN_TRUE' | 'BOOLEAN_FALSE' | 'NULL' | 'COMMAND_NAME' | 'PARAMETER_KEY' | 'PARAMETER_VALUE_SCOPE' | 'FUNCTION_NAME' | 'TIMESERIES_AGGREGATION' | 'TIMESERIES_AGGREGATION_EXPRESSION' | 'OPERATOR' | 'SEARCH_OPERATOR' | 'TRAVERSAL_OPERATOR' | 'TRAVERSAL_RELATION_NAME' | 'TRAVERSAL_HOP_COUNT' | 'SIMPLE_IDENTIFIER' | 'DATA_OBJECT' | 'NUMBER' | 'STRING' | 'TIME_UNIT' | 'TIMESTAMP_VALUE' | 'METRIC_KEY' | 'VARIABLE' | 'END_COMMENT' | 'UID_VALUE' | 'PARSE_PATTERN' | 'FIELD_PATTERN' | 'SEARCH_PATTERN' | 'ENTITY_SELECTOR_PART' | 'SAVED_TABLE_NAME' | 'TABULAR_FILE_NAME' | 'PARAMETER_MODIFIER' | 'FIELD_MODIFIER' | 'ENTITY_TYPE' | 'ENTITY_ATTRIBUTE' | 'SMARTSCAPE_ID_VALUE' | 'ENUM_STRING' | 'FIELD_PREFIX' | 'BUCKET' | 'SMARTSCAPE_NODE_PATTERN' | 'SMARTSCAPE_EDGE_PATTERN' | 'SMARTSCAPE_NODE_TYPE' | 'SMARTSCAPE_EDGE_TYPE';
     /**
      * For optional items only: whether this node becomes mandatory when user order is used. True only for some optional 'ghost braces'
      */

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

@@ -15,4 +15,8 @@ export interface ErrorResponse {
      * Error code, which normally matches the HTTP error code.
      */
     code: number;
+    /**
+     * The number of seconds to wait until the next retry.
+     */
+    retryAfterSeconds?: number;
 }

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

@@ -61,4 +61,8 @@ export interface ExecuteRequest {
      * Parameter to exclude the type information from the query result. In case not specified, the type information will be included.
      */
     includeTypes?: boolean;
+    /**
+     * Boolean to indicate if the query consumption limit should be enforced
+     */
+    enforceQueryConsumptionLimit?: boolean;
 }

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

@@ -50,9 +50,17 @@ export declare enum TokenType {
     SearchPattern = "SEARCH_PATTERN",
     EntitySelectorPart = "ENTITY_SELECTOR_PART",
     SavedTableName = "SAVED_TABLE_NAME",
+    TabularFileName = "TABULAR_FILE_NAME",
     ParameterModifier = "PARAMETER_MODIFIER",
     FieldModifier = "FIELD_MODIFIER",
     EntityType = "ENTITY_TYPE",
     EntityAttribute = "ENTITY_ATTRIBUTE",
-    SmartscapeIdValue = "SMARTSCAPE_ID_VALUE"
+    SmartscapeIdValue = "SMARTSCAPE_ID_VALUE",
+    EnumString = "ENUM_STRING",
+    FieldPrefix = "FIELD_PREFIX",
+    Bucket = "BUCKET",
+    SmartscapeNodePattern = "SMARTSCAPE_NODE_PATTERN",
+    SmartscapeEdgePattern = "SMARTSCAPE_EDGE_PATTERN",
+    SmartscapeNodeType = "SMARTSCAPE_NODE_TYPE",
+    SmartscapeEdgeType = "SMARTSCAPE_EDGE_TYPE"
 }

package/types/packages/{client/query/src/lib/apis → shared-client-utils/src}/api-client-options.d.ts

@@ -1,5 +1,5 @@
 /**
- * Configuration for generated TypeScript SDK clients
+ * Configuration for the API client.
  * @param {boolean} transformDates - Flag to control date transformations, enabled by default.
  */
 export interface ApiClientOptions {

package/types/packages/shared-client-utils/src/api-gateway-errors-handler.d.ts

@@ -0,0 +1,9 @@
+import type { HttpClientResponse } from '@dynatrace-sdk/http-client';
+/**
+ * Handles errors from API Gateway responses.
+ * Throws an ApiGatewayError if the response source is 'API Gateway'.
+ *
+ * @param {HttpClientResponse} response - The HTTP response to check for API Gateway errors.
+ * @throws {ApiGatewayError} If the response is from API Gateway and contains an error.
+ */
+export declare function apiGatewayErrorsHandler(response: HttpClientResponse): Promise<void>;

package/types/packages/shared-client-utils/src/encoding.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Available formats to transform models to and from
+ */
+export declare enum Encoding {
+    Json = "json",
+    Text = "text",
+    Binary = "binary",
+    FormData = "form-data"
+}
+/**
+ * Maps a MIME type string to an Encoding.
+ *
+ * @param {string} mimeType - The MIME type to convert (e.g., 'application/json').
+ * @param {Encoding} [defaultEncoding] - The encoding to return if the MIME type isn't recognized.
+ * @returns {Encoding} The corresponding Encoding enum value, or the defaultEncoding if not recognized.
+ */
+export declare function mimeTypeToEncoding(mimeType: string, defaultEncoding?: Encoding): Encoding;

package/types/packages/shared-client-utils/src/get-error-message.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns a user-friendly error message from an error body object.
+ *
+ * @param {unknown} errorBody - The error object or response body to extract the message from.
+ * @param {string} defaultMessage - The default message to use if no error message is found.
+ * @returns {string} The extracted or default error message, possibly including details.
+ */
+export declare function getErrorMessage(errorBody: unknown, defaultMessage: string): string;

package/types/packages/shared-client-utils/src/index.d.ts

@@ -0,0 +1,6 @@
+export * from './api-client-options';
+export * from './api-gateway-errors-handler';
+export * from './encoding';
+export * from './get-error-message';
+export * from './transformations';
+export * from './url-helpers';

package/types/packages/shared-client-utils/src/transformations.d.ts

@@ -0,0 +1,64 @@
+import { FormDataRequestBody, FormDataRequestField, FormDataResponseBody } from '@dynatrace-sdk/http-client';
+export type TransformRuleConfig = {
+    force?: boolean;
+    datetime?: boolean;
+};
+export type TransformRulesParam = Array<string | [string, TransformRuleConfig]>;
+/**
+ * Transforms an object by applying transformation rules before sending it in a request.
+ *
+ * @template T
+ * @param {T} object - The object to transform.
+ * @param {TransformRulesParam} rules - The transformation rules to apply.
+ * @returns {T} The transformed object.
+ */
+export declare function transformRequest<T = any>(object: T, rules: TransformRulesParam): T;
+/**
+ * Transforms an object by applying transformation rules after receiving it in a response.
+ *
+ * @template T
+ * @param {T} object - The object to transform.
+ * @param {TransformRulesParam} rules - The transformation rules to apply.
+ * @returns {T} The transformed object.
+ */
+export declare function transformResponse<T = any>(object: T, rules: TransformRulesParam): T;
+export interface FormDataRequestFieldDefinition {
+    key: string;
+    type: 'text' | 'json' | 'binary';
+    required: boolean;
+}
+export interface FormDataResponseGenericFieldDefinition {
+    type: 'text' | 'binary';
+}
+export interface FormDataResponseJsonFieldDefinition {
+    type: 'json';
+    transformations: Array<string | [string, TransformRuleConfig]>;
+}
+export type FormDataResponseFieldDefinition = FormDataResponseGenericFieldDefinition | FormDataResponseJsonFieldDefinition;
+/**
+ * Converts an object to a FormDataRequestBody using field definitions.
+ *
+ * @template T
+ * @param {T} value - The object to convert.
+ * @param {Array<FormDataRequestFieldDefinition>} fields - The field definitions for the form data.
+ * @returns {FormDataRequestBody} The resulting form data body.
+ */
+export declare function transformToFormData<T extends Record<any, any>>(value: T, fields: Array<FormDataRequestFieldDefinition>): FormDataRequestBody;
+/**
+ * Converts a value to a FormDataRequestField based on the field definition.
+ *
+ * @template T
+ * @param {T} value - The value to convert.
+ * @param {FormDataRequestFieldDefinition} field - The field definition.
+ * @returns {FormDataRequestField | null} The resulting form data field or null if not required and undefined.
+ */
+export declare function transformToFormDataField<T = any>(value: T, field: FormDataRequestFieldDefinition): FormDataRequestField | null;
+/**
+ * Converts form data and field definitions into a typed object, applying transformations for JSON fields.
+ *
+ * @template T
+ * @param {FormDataResponseBody} formData - The form data to convert.
+ * @param {Record<string, FormDataResponseFieldDefinition>} fields - The field definitions for the form data.
+ * @returns {T} The resulting typed object.
+ */
+export declare function transformFromFormData<T extends Record<any, any>>(formData: FormDataResponseBody, fields: Record<string, FormDataResponseFieldDefinition>): T;

package/types/packages/shared-client-utils/src/url-helpers.d.ts

@@ -0,0 +1,12 @@
+export type QueryParamsType = Record<string | number, any>;
+export interface ParametersFlags {
+    explode?: Record<string, boolean>;
+}
+/**
+ * Converts an object of query parameters into a URL query string.
+ *
+ * @param {QueryParamsType} [rawQuery] - The object containing query parameters.
+ * @param {ParametersFlags} [flags] - Flags to control parameter formatting (e.g., explode arrays).
+ * @returns {string} The resulting query string.
+ */
+export declare const toQueryString: (rawQuery?: QueryParamsType, flags?: ParametersFlags) => string;

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

@@ -1,2 +0,0 @@
-import { HttpClientResponse } from '@dynatrace-sdk/http-client';
-export declare function apiGatewayErrorsHandler(response: HttpClientResponse): Promise<void>;

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

@@ -1 +0,0 @@
-export declare function getErrorMessage(errorBody: unknown, defaultMessage: string): string;

package/types/packages/client/query/src/lib/utils/encoding.d.ts

@@ -1,10 +0,0 @@
-/**
- * Available formats to transform models to and from
- */
-export declare enum Encoding {
-    Json = "json",
-    Text = "text",
-    Binary = "binary",
-    FormData = "form-data"
-}
-export declare function mimeTypeToEncoding(mimeType: string, defaultEncoding?: Encoding): Encoding;

package/types/packages/client/query/src/lib/utils/transformations.d.ts

@@ -1,7 +0,0 @@
-type TransformRuleConfig = {
-    force?: boolean;
-    datetime?: boolean;
-};
-export declare function transformRequest<T = any>(object: T, keys: Array<string | [string, TransformRuleConfig]>): T;
-export declare function transformResponse<T = any>(object: T, keys: Array<string | [string, TransformRuleConfig]>): T;
-export {};

package/types/packages/client/query/src/lib/utils/url-helpers.d.ts

@@ -1,6 +0,0 @@
-type QueryParamsType = Record<string | number, any>;
-interface ParametersFlags {
-    explode?: Record<string, boolean>;
-}
-export declare const toQueryString: (rawQuery?: QueryParamsType, flags?: ParametersFlags) => string;
-export {};