import { EventEmitter } from 'node:events'; import { Command, Interfaces } from '@oclif/core'; import { AnyJson } from '@salesforce/ts-types'; export type CommandClass = Pick & { topic: string; subtopic: string; longDescription?: string; binary: string; deprecated?: boolean; }; export declare const events: EventEmitter<[never]>; export declare function punctuate(description?: string): string | undefined; export declare const replaceConfigVariables: (text: string, bin: string, id: string) => string; /** * Converts the `<` and `>` characters to their HTML entity equivalents (`<` and `>`) * so they render as literal characters instead of being interpreted as HTML tags. */ export declare function escapeAngleBrackets(text: string): string; /** * Resolves a command's state (and deprecation) to the label shown next to its name, or `null` * when there's nothing to show. Both pilot states render as "Pilot". */ export declare function stateLabel(state: unknown, deprecated?: boolean): string | null; /** * Returns the base filename (without extension) for a command's reference page. * * A command ID with no subtopic (e.g. "doctor") would collide with the topic index file * (cli_reference_doctor.md), so its page is suffixed with `_command` to disambiguate. */ export declare function commandFileBase(id: string): string; /** Returns the relative Markdown filename to link to a command's reference page. */ export declare function commandLinkTarget(id: string): string; export type CliMeta = { binary: string; topicSeparator?: string; state?: string; description?: string; longDescription?: string | AnyJson; }; type PluginVersion = { name: string; version: string; }; type BaseDitamapData = { namespaceDitamapFiles: string[]; }; type CliRefData = { cliVersion: string; pluginVersions: PluginVersion[]; }; type CliRefHelpData = { id: string; }; type ClIRefTopicData = { topic: string; longDescription?: string; }; export type CommandParameterData = { description: string[]; optional?: boolean; char?: string; name: string; hasValue?: boolean; deprecated?: { version: string; to: string; }; kind?: string; options?: string[]; defaultFlagValue?: string; aliases?: string[]; }; export type DitamapData = CliRefHelpData | BaseDitamapData | CliRefData | ClIRefTopicData | CommandData | SfTopic | TopicDitamapData | undefined; export type CommandData = { name: string; summary?: string; description?: string; binary: string; commandWithUnderscores: string; isClosedPilotCommand: boolean; isOpenPilotCommand: boolean; isBetaCommand: boolean; isPreviewCommand: boolean; deprecated: boolean; trailblazerCommunityUrl?: string; trailblazerCommunityName?: string; help?: string[]; examples?: unknown[]; parameters?: CommandParameterData[]; }; type TopicDitamapData = { topic: string; commands: Array<{ command: string; }>; }; export type SfTopic = Interfaces.Topic & { external?: boolean; trailblazerCommunityLink?: { url: string; name: string; }; subtopics?: SfTopics; }; export type SfTopics = Map; export {};