sfdx-hardis/lib/common/docBuilder/docUtils.d.ts

Swiss-army-knife Toolbox for Salesforce. Allows you to define a complete CD/CD Pipeline. Orchestrate base commands and assist users with interactive wizards

export declare function readMkDocsFile(mkdocsYmlFile: string): any;
export declare function writeMkDocsFile(mkdocsYmlFile: string, mkdocsYml: any): Promise<void>;
export declare class SalesforceSetupUrlBuilder {
    /**
     * Map of metadata types to their Lightning Experience setup paths.
     */
    private static readonly setupAreaMap;
    /**
     * Generates the setup URL for a given metadata type and API name (if required).
     * @param metadataType The metadata type (e.g., "CustomObject", "ApexClass").
     * @param apiName The API name of the metadata (optional, e.g., "Account").
     * @returns The constructed setup URL.
     * @throws Error if the metadata type is unsupported or the API name is missing for required types.
     */
    static getSetupUrl(metadataType: string, apiName: string): string | null;
}
export declare function completeAttributesDescriptionWithAi(attributesMarkdown: string, objectName: string): Promise<string>;
export declare function replaceInFile(filePath: string, stringToReplace: string, replaceWith: string): Promise<void>;
export declare function generateMkDocsHTML(): Promise<void>;
export declare function installMkDocs(): Promise<boolean>;
export declare function getMetaHideLines(): string;
export declare function includeFromFile(cacheFilePath: string, content: string): string;