dt-app/lib/src/build/bundle-documents.d.ts

The Dynatrace App Toolkit is a tool you can use from your command line to create, develop, and deploy apps on your Dynatrace environment.

import { type Diagnostic } from './diagnostic';
import type { DocumentsManifest, DocumentTypes } from '../utils/config/cli-options';
/**
 * Creates a filemap of documents. Also returns diagnostics about possible naming violations
 * @param documents all the documents we will transform into a filemap
 * @returns Object with Filemap based on all the documents and the diagnostics with all the errors found
 */
export declare function createDocumentsFilemap(documents: string[]): Diagnostic[];
/**
 * Extracts the document name from a file path
 * @param filePath Path to the document file
 * @returns The document name
 */
export declare function getDocumentName(filePath: string): string;
/**
 * Create a filemap of document types. Also returns diagnostics about possible violations
 * @param documentTypeIconPaths paths to document type icons
 * @param documentTypes all the documents we will transform into a filemap
 * @returns Array of diagnostics
 */
export declare function createDocumentTypesDiagnostic(documentTypeIconPaths: string[], documentTypes: DocumentTypes): Diagnostic[];
/**
 * Validates document files against the app config
 * @param documentPaths paths to document files in the documents/ folder
 * @param configuredDocuments documents configuration from the app config
 * @returns Array of diagnostics
 */
export declare function createDocumentConfigDiagnostics(documentPaths: string[], configuredDocuments: DocumentsManifest | undefined): Diagnostic[];