sfdx-hardis/lib/common/utils/notifUtils.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

import { NotifSeverity } from "../notifProvider/index.js";
/**
 * @description This function retrieves the job URL from the GitProvider and creates a notification button if the job URL exists.
 * The notification button is an object with a 'text' property set to "View Job" and a 'url' property set to the job URL.
 * It returns an array of such notification buttons.
 *
 * @returns {Promise<{ text: string; url: string }[]>} - A Promise that resolves to an array of notification buttons.
 */
export declare function getNotificationButtons(): Promise<{
    text: string;
    url: string;
}[]>;
/**
 * @descriptionThis function retrieves the current Git branch and its URL from the GitProvider.
 * It then generates a markdown string for the branch.
 * If the branch URL exists, it creates a markdown link with the branch name as the link text.
 * Otherwise, it simply formats the branch name in markdown.
 *
 * @returns {Promise<string>} - A Promise that resolves to a markdown string for the current Git branch.
 */
export declare function getBranchMarkdown(type?: string): Promise<string>;
/**
 * @descriptionThis function retrieves the current Git branch and its URL from the GitProvider.
 * It then generates a markdown string for the branch.
 * If the branch URL exists, it creates a markdown link with the branch name as the link text.
 * Otherwise, it simply formats the branch name in markdown.
 *
 * @returns {Promise<string>} - A Promise that resolves to a markdown string for the current Git branch.
 */
export declare function getOrgMarkdown(instanceUrl: string, type?: string): Promise<string>;
type RemoveMarkdownOptions = {
    stripListLeaders?: boolean;
    listUnicodeChar: string | boolean;
    gfm?: boolean;
    useImgAltText?: boolean;
    preserveLinks?: boolean;
};
/**
 * @function removeMarkdown
 *
 * @description
 * Parse the markdown and returns a string
 *
 * @param markdown - The markdown string to parse
 * @param options - The options for the function
 *
 * @returns The parsed plain text
 */
export declare function removeMarkdown(markdown: string, optionsIn?: RemoveMarkdownOptions): string;
export declare function getSeverityIcon(severity: NotifSeverity): string;
export {};