dt-app
Version:
The Dynatrace App Toolkit is a tool you can use from your command line to create, develop, and deploy apps on your Dynatrace environment.
104 lines (103 loc) • 4.01 kB
TypeScript
/**
* @license
* Copyright 2024 Dynatrace LLC
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import type { DtApp, DtAppPlugin } from './src/plugin/plugin';
import type { BeforeBuildCallback, BeforeServeCallBack } from './src/plugin/hooks';
import { type RunFunctionOptions, executeFunction } from './src/execute-function/execute-function';
import { getBearerToken } from './src/auth/get-bearer-token';
import { getDtAppFileConfig } from './src/utils/config/get-dt-app-file-config';
import { dtFetch, type Response as UndiciResponse, type RequestOptions as UndiciRequestOptions } from './src/utils/request';
import { getSSOUrl } from './src/utils/get-sso-url';
import { extractDtAppConfigFromTs } from './src/utils/config/extract-dt-app-config-from-ts';
import { mergeOptions } from './src/utils/config/cli-options';
export { UiCommands, OperatingSystem, CliAsset, CliUiSource, EsbuildPlugin, PluginConfiguration, BuildOptions, ServerOptions, AppOptions, ActionBase, Action, ActionManifest, SettingsManifest, DocumentsManifest, DocumentTypesManifest, FunctionManifest, CSPAppDirectives, DirectiveValue, CliOptions, DocumentTypes, CliFlags, CliFlagOptions, OAuthScope, ResolvedCliOptions, getDefaultCliOptions, } from './src/utils/config/cli-options';
export { DevServer } from './src/utils/dev-server';
export { DynatraceApplicationManifest as _InternalDynatraceApplicationManifest } from './src/interfaces/manifest';
export { prepareManifest as _InternalPrepareManifest } from './src/utils/prepare-manifest';
/**
* Interface for collecting callbacks of a plugin during its setup
* @internal
* @experimental
*/
export type _DtApp = DtApp;
/**
* Plugin that can be registered/used by the dt-app
* @internal
* @experimental
*/
export type _DtAppPlugin = DtAppPlugin;
/**
* Callback function to be applied before the build
* @internal
* @experimental
*/
export type _BeforeBuildCallback = BeforeBuildCallback;
/**
* Callback function to be applied before serving
* @experimental
* @internal
*/
export type _BeforeServeCallBack = BeforeServeCallBack;
/**
* @internal
*/
export type _RunFunctionOptions = RunFunctionOptions;
/**
* Executes an app function using the Dynatrace JS Runtime
* @param options
* @returns function response
* @internal
*/
export declare const _ExecuteFunction: typeof executeFunction;
/**
* Wrapper function that will validate and return token without returning token validity
* @internal
*/
export declare const _GetBearerToken: typeof getBearerToken;
/**
* Configurations from config file (if one exists), from command line flags and default
* configurations get merged and returned
* @internal
*/
export declare const _MergeOptions: typeof mergeOptions;
/**
* Searches for app.config.{json,js,ts} in root of project and returns config if one exists
* @internal
*/
export declare const _GetDtAppFileConfig: typeof getDtAppFileConfig;
/**
* Sends request using undici and returns a response
* @internal
*/
export declare const _Fetch: typeof dtFetch;
/**
* @internal
*/
export type _Response = UndiciResponse;
/**
* @internal
*/
export type _RequestOptions = UndiciRequestOptions;
/**
* Builds the SSOUrl based on the environment
* @param environmentUrl envUrl is used to fetch the ssoUrl
* @internal
*/
export declare const _GetSSOUrl: typeof getSSOUrl;
/**
* Extracts and transpiles the dt-app configuration from a TypeScript config file.
* @internal
*/
export declare const _ExtractDtAppConfigFromTs: typeof extractDtAppConfigFromTs;